Package org.basex.io.serial

Class SerializerOptions

java.lang.Object

org.basex.util.options.Options

org.basex.io.serial.SerializerOptions

All Implemented Interfaces:

Iterable<Option<?>>

public final class SerializerOptions
extends Options

This class defines all available serialization parameters.

Author:

BaseX Team 2005-21, BSD License, Christian Gruen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SerializerOptions.Newline	Newlines.

Nested classes/interfaces inherited from class org.basex.util.options.Options

Options.YesNo, Options.YesNoOmit

Field Summary

Fields

Modifier and Type	Field	Description
static final EnumOption<Options.YesNo>	ALLOW_DUPLICATE_NAMES	Serialization parameter: xml/xhtml/html/text.
static final EnumOption<Options.YesNo>	BINARY	Specific serialization parameter: binary serialization.
static final EnumOption<Options.YesNo>	BYTE_ORDER_MARK	Serialization parameter: yes/no.
static final StringOption	CDATA_SECTION_ELEMENTS	Serialization parameter: list of QNames.
static final OptionsOption<CsvOptions>	CSV	Specific serialization parameter.
static final StringOption	DOCTYPE_PUBLIC	Serialization parameter.
static final StringOption	DOCTYPE_SYSTEM	Serialization parameter.
static final StringOption	ENCODING	Serialization parameter: valid encoding.
static final EnumOption<Options.YesNo>	ESCAPE_URI_ATTRIBUTES	Serialization parameter: yes/no.
static final StringOption	HTML_VERSION	Serialization parameter: 4.0/4.01/5.0.
static final EnumOption<Options.YesNo>	INCLUDE_CONTENT_TYPE	Serialization parameter: yes/no.
static final EnumOption<Options.YesNo>	INDENT	Serialization parameter: yes/no.
static final NumberOption	INDENTS	Specific serialization parameter: number of spaces to indent.
static final StringOption	ITEM_SEPARATOR	Serialization parameter.
static final OptionsOption<JsonSerialOptions>	JSON	Specific serialization parameter.
static final EnumOption<SerialMethod>	JSON_NODE_OUTPUT_METHOD	Serialization parameter: xml/xhtml/html/text.
static final NumberOption	LIMIT	Specific serialization parameter: maximum number of bytes to serialize.
static final StringOption	MEDIA_TYPE	Serialization parameter.
static final EnumOption<SerialMethod>	METHOD	Serialization parameter: xml/xhtml/html/text/json/csv/raw/adaptive.
static final EnumOption<SerializerOptions.Newline>	NEWLINE	Specific serialization parameter: newline.
static final StringOption	NORMALIZATION_FORM	Serialization parameter: NFC/NFD/NFKC/NKFD/fully-normalized/none.
static final EnumOption<Options.YesNo>	OMIT_XML_DECLARATION	Serialization parameter: yes/no.
static final StringOption	PARAMETER_DOCUMENT	Parameter document.
static final EnumOption<Options.YesNoOmit>	STANDALONE	Serialization parameter: yes/no/omit.
static final StringOption	SUPPRESS_INDENTATION	Serialization parameter.
static final EnumOption<Options.YesNo>	TABULATOR	Specific serialization parameter: indent with spaces or tabs.
static final EnumOption<Options.YesNo>	UNDECLARE_PREFIXES	Serialization parameter: yes/no.
static final StringOption	USE_CHARACTER_MAPS	Serialization parameter.
static final StringOption	VERSION	Serialization parameter: 1.0/1.1.

Constructor Summary

Constructors

Constructor	Description
SerializerOptions()	Default constructor.
SerializerOptions(SerializerOptions opts)	Constructor with options to be copied.

Method Summary

Modifier and Type	Method	Description
static String	characterMap(ANode elem)	Extracts a character map.
void	parse(String name, byte[] value, StaticContext sc, InputInfo ii)	Parses options.
boolean	yes(EnumOption<Options.YesNo> option)	Checks if the specified option is true.

Methods inherited from class org.basex.util.options.Options

allowed, assign, assign, assign, assign, assign, contains, error, free, get, get, get, get, get, get, get, get, get, invert, iterator, names, option, put, set, set, set, set, set, set, set, set, setSystem, toMap, toMap, toString, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

BYTE_ORDER_MARK

public static final EnumOption<Options.YesNo> BYTE_ORDER_MARK

Serialization parameter: yes/no.

CDATA_SECTION_ELEMENTS

public static final StringOption CDATA_SECTION_ELEMENTS

Serialization parameter: list of QNames.

DOCTYPE_PUBLIC

public static final StringOption DOCTYPE_PUBLIC

Serialization parameter.

DOCTYPE_SYSTEM

public static final StringOption DOCTYPE_SYSTEM

Serialization parameter.

ENCODING

public static final StringOption ENCODING

Serialization parameter: valid encoding.

ESCAPE_URI_ATTRIBUTES

public static final EnumOption<Options.YesNo> ESCAPE_URI_ATTRIBUTES

Serialization parameter: yes/no.

INCLUDE_CONTENT_TYPE

public static final EnumOption<Options.YesNo> INCLUDE_CONTENT_TYPE

Serialization parameter: yes/no.

INDENT

public static final EnumOption<Options.YesNo> INDENT

Serialization parameter: yes/no.

SUPPRESS_INDENTATION

public static final StringOption SUPPRESS_INDENTATION

Serialization parameter.

MEDIA_TYPE

public static final StringOption MEDIA_TYPE

Serialization parameter.

METHOD

public static final EnumOption<SerialMethod> METHOD

Serialization parameter: xml/xhtml/html/text/json/csv/raw/adaptive.

NORMALIZATION_FORM

public static final StringOption NORMALIZATION_FORM

Serialization parameter: NFC/NFD/NFKC/NKFD/fully-normalized/none.

OMIT_XML_DECLARATION

public static final EnumOption<Options.YesNo> OMIT_XML_DECLARATION

Serialization parameter: yes/no.

STANDALONE

public static final EnumOption<Options.YesNoOmit> STANDALONE

Serialization parameter: yes/no/omit.

UNDECLARE_PREFIXES

public static final EnumOption<Options.YesNo> UNDECLARE_PREFIXES

Serialization parameter: yes/no.

USE_CHARACTER_MAPS

public static final StringOption USE_CHARACTER_MAPS

Serialization parameter.

ITEM_SEPARATOR

public static final StringOption ITEM_SEPARATOR

Serialization parameter.

VERSION

public static final StringOption VERSION

Serialization parameter: 1.0/1.1.

HTML_VERSION

public static final StringOption HTML_VERSION

Serialization parameter: 4.0/4.01/5.0.

PARAMETER_DOCUMENT

public static final StringOption PARAMETER_DOCUMENT

Parameter document.

ALLOW_DUPLICATE_NAMES

public static final EnumOption<Options.YesNo> ALLOW_DUPLICATE_NAMES

Serialization parameter: xml/xhtml/html/text.

JSON_NODE_OUTPUT_METHOD

public static final EnumOption<SerialMethod> JSON_NODE_OUTPUT_METHOD

Serialization parameter: xml/xhtml/html/text.

CSV

public static final OptionsOption<CsvOptions> CSV

Specific serialization parameter.

JSON

public static final OptionsOption<JsonSerialOptions> JSON

Specific serialization parameter.

NEWLINE

public static final EnumOption<SerializerOptions.Newline> NEWLINE

Specific serialization parameter: newline.

TABULATOR

public static final EnumOption<Options.YesNo> TABULATOR

Specific serialization parameter: indent with spaces or tabs.

INDENTS

public static final NumberOption INDENTS

Specific serialization parameter: number of spaces to indent.

LIMIT

public static final NumberOption LIMIT

Specific serialization parameter: maximum number of bytes to serialize.

BINARY

public static final EnumOption<Options.YesNo> BINARY

Specific serialization parameter: binary serialization.

Constructor Details

SerializerOptions

public SerializerOptions()

Default constructor.

SerializerOptions

public SerializerOptions(SerializerOptions opts)

Constructor with options to be copied.

Parameters:

opts - options

Method Details

yes

public boolean yes(EnumOption<Options.YesNo> option)

Checks if the specified option is true.

Parameters:

option - option

Returns:

value

parse

public void parse(String name,
 byte[] value,
 StaticContext sc,
 InputInfo ii)
           throws QueryException

Parses options.

Parameters:

name - name of option

value - value

sc - static context

ii - input info

Throws:

QueryException - query exception

characterMap

public static String characterMap(ANode elem)

Extracts a character map.

Parameters:

elem - child node

Returns:

character map or null if map is invalid