net.sf.saxon.functions

Class OptionsParameter

java.lang.Object

net.sf.saxon.functions.OptionsParameter

public class OptionsParameter
extends Object

This class implements the rules for options parameters, as used in functions such as parse-json, serialize, json-to-XML, map:merge. It provides a convenient way of ensuring that the options parameter conventions are enforced.

Constructor Summary

Constructors

Constructor and Description
OptionsParameter()

Method Summary

Modifier and Type	Method and Description
void	addAllowedOption(String name, SequenceType type)
void	addAllowedOption(String name, SequenceType type, Sequence defaultValue)
Map<String,Sequence>	getDefaultOptions()
Map<String,Sequence>	processSuppliedOptions(MapItem supplied, XPathContext context)
void	setAllowedValues(String name, String errorCode, String... values)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OptionsParameter

public OptionsParameter()

Method Detail

addAllowedOption

public void addAllowedOption(String name,
                             SequenceType type)

addAllowedOption

public void addAllowedOption(String name,
                             SequenceType type,
                             Sequence defaultValue)

setAllowedValues

public void setAllowedValues(String name,
                             String errorCode,
                             String... values)

processSuppliedOptions

public Map<String,Sequence> processSuppliedOptions(MapItem supplied,
                                                   XPathContext context)
                                            throws XPathException

Throws:

XPathException

getDefaultOptions

public Map<String,Sequence> getDefaultOptions()
                                       throws XPathException

Throws:

XPathException