org.basex.io.serial
Class SerializerProp

java.lang.Object
  extended by org.basex.core.AProp
      extended by org.basex.io.serial.SerializerProp
All Implemented Interfaces:
java.lang.Iterable<java.lang.String>

public final class SerializerProp
extends AProp

This class defines all available serialization parameters.

Author:
BaseX Team 2005-12, BSD License, Christian Gruen

Field Summary
static java.lang.Object[] S_BYTE_ORDER_MARK
          Serialization parameter: yes/no.
static java.lang.Object[] S_CDATA_SECTION_ELEMENTS
          Serialization parameter: list of QNames.
static java.lang.Object[] S_DOCTYPE_PUBLIC
          Serialization parameter.
static java.lang.Object[] S_DOCTYPE_SYSTEM
          Serialization parameter.
static java.lang.Object[] S_ENCODING
          Serialization parameter: valid encoding.
static java.lang.Object[] S_ESCAPE_URI_ATTRIBUTES
          Serialization parameter: yes/no.
static java.lang.Object[] S_FORMAT
          Specific serialization parameter: formatting.
static java.lang.Object[] S_HTML_VERSION
          Serialization parameter: 4.0/4.01/5.0.
static java.lang.Object[] S_INCLUDE_CONTENT_TYPE
          Serialization parameter: yes/no.
static java.lang.Object[] S_INDENT
          Serialization parameter: yes/no.
static java.lang.Object[] S_INDENTS
          Specific serialization parameter: number of spaces to indent.
static java.lang.Object[] S_ITEM_SEPARATOR
          Serialization parameter.
static java.lang.Object[] S_MEDIA_TYPE
          Serialization parameter.
static java.lang.Object[] S_METHOD
          Serialization parameter: xml/xhtml/html/text.
static java.lang.Object[] S_NEWLINE
          Specific serialization parameter: newline.
static java.lang.Object[] S_NORMALIZATION_FORM
          Serialization parameter: NFC/NFD/NFKC/NKFD/fully-normalized/none.
static java.lang.Object[] S_OMIT_XML_DECLARATION
          Serialization parameter: yes/no.
static java.lang.Object[] S_PARAMETER_DOCUMENT
          Parameter document.
static java.lang.Object[] S_SEPARATOR
          Specific serialization parameter: item separator.
static java.lang.Object[] S_STANDALONE
          Serialization parameter: yes/no/omit.
static java.lang.Object[] S_SUPPRESS_INDENTATION
          Serialization parameter.
static java.lang.Object[] S_TABULATOR
          Specific serialization parameter: indent with spaces or tabs.
static java.lang.Object[] S_UNDECLARE_PREFIXES
          Serialization parameter: yes/no.
static java.lang.Object[] S_USE_CHARACTER_MAPS
          Serialization parameter.
static java.lang.Object[] S_VERSION
          Serialization parameter: 1.0/1.1.
static java.lang.Object[] S_WRAP_PREFIX
          Specific serialization parameter: prefix of result wrapper.
static java.lang.Object[] S_WRAP_URI
          Specific serialization parameter: URI of result wrapper.
 StringList unknown
          Unknown properties.
 
Fields inherited from class org.basex.core.AProp
props
 
Constructor Summary
SerializerProp()
          Constructor.
SerializerProp(java.lang.String s)
          Constructor, specifying initial properties.
 
Method Summary
static java.lang.String allowed(java.lang.Object key, java.lang.String found, java.lang.String... allowed)
          Returns a list of allowed keys.
 java.lang.String check(java.lang.Object[] key, java.lang.String... allowed)
          Retrieves a value from the specified property and checks allowed values.
static SerializerException error(java.lang.Object key, java.lang.String found, java.lang.String... allowed)
          Returns an exception string for a wrong key.
 java.lang.String supported(java.lang.Object[] key, java.lang.String... allowed)
          Retrieves a value from the specified property and checks for supported values.
 boolean yes(java.lang.Object[] key)
          Retrieves a value from the specified property and checks for its boolean value.
 
Methods inherited from class org.basex.core.AProp
get, get, getSystem, getSystem, invert, is, iterator, num, nums, parse, props, sameAs, set, set, set, set, set, set, setObject, setSystem, setSystem, setSystem, similar, strings, toString, unknown, write
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

S_BYTE_ORDER_MARK

public static final java.lang.Object[] S_BYTE_ORDER_MARK
Serialization parameter: yes/no.


S_CDATA_SECTION_ELEMENTS

public static final java.lang.Object[] S_CDATA_SECTION_ELEMENTS
Serialization parameter: list of QNames.


S_DOCTYPE_PUBLIC

public static final java.lang.Object[] S_DOCTYPE_PUBLIC
Serialization parameter.


S_DOCTYPE_SYSTEM

public static final java.lang.Object[] S_DOCTYPE_SYSTEM
Serialization parameter.


S_ENCODING

public static final java.lang.Object[] S_ENCODING
Serialization parameter: valid encoding.


S_ESCAPE_URI_ATTRIBUTES

public static final java.lang.Object[] S_ESCAPE_URI_ATTRIBUTES
Serialization parameter: yes/no.


S_INCLUDE_CONTENT_TYPE

public static final java.lang.Object[] S_INCLUDE_CONTENT_TYPE
Serialization parameter: yes/no.


S_INDENT

public static final java.lang.Object[] S_INDENT
Serialization parameter: yes/no.


S_SUPPRESS_INDENTATION

public static final java.lang.Object[] S_SUPPRESS_INDENTATION
Serialization parameter.


S_MEDIA_TYPE

public static final java.lang.Object[] S_MEDIA_TYPE
Serialization parameter.


S_METHOD

public static final java.lang.Object[] S_METHOD
Serialization parameter: xml/xhtml/html/text.


S_NORMALIZATION_FORM

public static final java.lang.Object[] S_NORMALIZATION_FORM
Serialization parameter: NFC/NFD/NFKC/NKFD/fully-normalized/none.


S_OMIT_XML_DECLARATION

public static final java.lang.Object[] S_OMIT_XML_DECLARATION
Serialization parameter: yes/no.


S_STANDALONE

public static final java.lang.Object[] S_STANDALONE
Serialization parameter: yes/no/omit.


S_UNDECLARE_PREFIXES

public static final java.lang.Object[] S_UNDECLARE_PREFIXES
Serialization parameter: yes/no.


S_USE_CHARACTER_MAPS

public static final java.lang.Object[] S_USE_CHARACTER_MAPS
Serialization parameter.


S_ITEM_SEPARATOR

public static final java.lang.Object[] S_ITEM_SEPARATOR
Serialization parameter.


S_VERSION

public static final java.lang.Object[] S_VERSION
Serialization parameter: 1.0/1.1.


S_HTML_VERSION

public static final java.lang.Object[] S_HTML_VERSION
Serialization parameter: 4.0/4.01/5.0.


S_PARAMETER_DOCUMENT

public static final java.lang.Object[] S_PARAMETER_DOCUMENT
Parameter document.


S_NEWLINE

public static final java.lang.Object[] S_NEWLINE
Specific serialization parameter: newline.


S_FORMAT

public static final java.lang.Object[] S_FORMAT
Specific serialization parameter: formatting.


S_TABULATOR

public static final java.lang.Object[] S_TABULATOR
Specific serialization parameter: indent with spaces or tabs.


S_INDENTS

public static final java.lang.Object[] S_INDENTS
Specific serialization parameter: number of spaces to indent.


S_SEPARATOR

public static final java.lang.Object[] S_SEPARATOR
Specific serialization parameter: item separator.


S_WRAP_PREFIX

public static final java.lang.Object[] S_WRAP_PREFIX
Specific serialization parameter: prefix of result wrapper.


S_WRAP_URI

public static final java.lang.Object[] S_WRAP_URI
Specific serialization parameter: URI of result wrapper.


unknown

public final StringList unknown
Unknown properties.

Constructor Detail

SerializerProp

public SerializerProp()
Constructor.


SerializerProp

public SerializerProp(java.lang.String s)
Constructor, specifying initial properties.

Parameters:
s - property string. Properties are separated with commas (,), key/values with the equality character (=).
Method Detail

check

public java.lang.String check(java.lang.Object[] key,
                              java.lang.String... allowed)
                       throws SerializerException
Retrieves a value from the specified property and checks allowed values.

Parameters:
key - property key
allowed - allowed values
Returns:
value
Throws:
SerializerException - serializer exception

supported

public java.lang.String supported(java.lang.Object[] key,
                                  java.lang.String... allowed)
                           throws SerializerException
Retrieves a value from the specified property and checks for supported values.

Parameters:
key - property key
allowed - allowed values
Returns:
value
Throws:
SerializerException - serializer exception

yes

public boolean yes(java.lang.Object[] key)
            throws SerializerException
Retrieves a value from the specified property and checks for its boolean value.

Parameters:
key - property key
Returns:
value
Throws:
SerializerException - serializer exception

error

public static SerializerException error(java.lang.Object key,
                                        java.lang.String found,
                                        java.lang.String... allowed)
                                 throws SerializerException
Returns an exception string for a wrong key.

Parameters:
key - property key
found - found value
allowed - allowed values
Returns:
exception
Throws:
SerializerException - serializer exception

allowed

public static java.lang.String allowed(java.lang.Object key,
                                       java.lang.String found,
                                       java.lang.String... allowed)
Returns a list of allowed keys.

Parameters:
key - property key
found - found value
allowed - allowed values
Returns:
exception