|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.basex.core.AProp
org.basex.io.serial.SerializerProp
public final class SerializerProp
This class defines all available serialization parameters.
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 |
---|
public static final java.lang.Object[] S_BYTE_ORDER_MARK
public static final java.lang.Object[] S_CDATA_SECTION_ELEMENTS
public static final java.lang.Object[] S_DOCTYPE_PUBLIC
public static final java.lang.Object[] S_DOCTYPE_SYSTEM
public static final java.lang.Object[] S_ENCODING
public static final java.lang.Object[] S_ESCAPE_URI_ATTRIBUTES
public static final java.lang.Object[] S_INCLUDE_CONTENT_TYPE
public static final java.lang.Object[] S_INDENT
public static final java.lang.Object[] S_SUPPRESS_INDENTATION
public static final java.lang.Object[] S_MEDIA_TYPE
public static final java.lang.Object[] S_METHOD
public static final java.lang.Object[] S_NORMALIZATION_FORM
public static final java.lang.Object[] S_OMIT_XML_DECLARATION
public static final java.lang.Object[] S_STANDALONE
public static final java.lang.Object[] S_UNDECLARE_PREFIXES
public static final java.lang.Object[] S_USE_CHARACTER_MAPS
public static final java.lang.Object[] S_ITEM_SEPARATOR
public static final java.lang.Object[] S_VERSION
public static final java.lang.Object[] S_HTML_VERSION
public static final java.lang.Object[] S_PARAMETER_DOCUMENT
public static final java.lang.Object[] S_NEWLINE
public static final java.lang.Object[] S_FORMAT
public static final java.lang.Object[] S_TABULATOR
public static final java.lang.Object[] S_INDENTS
public static final java.lang.Object[] S_SEPARATOR
public static final java.lang.Object[] S_WRAP_PREFIX
public static final java.lang.Object[] S_WRAP_URI
public final StringList unknown
Constructor Detail |
---|
public SerializerProp()
public SerializerProp(java.lang.String s)
s
- property string. Properties are separated with commas (,
),
key/values with the equality character (=
).Method Detail |
---|
public java.lang.String check(java.lang.Object[] key, java.lang.String... allowed) throws SerializerException
key
- property keyallowed
- allowed values
SerializerException
- serializer exceptionpublic java.lang.String supported(java.lang.Object[] key, java.lang.String... allowed) throws SerializerException
key
- property keyallowed
- allowed values
SerializerException
- serializer exceptionpublic boolean yes(java.lang.Object[] key) throws SerializerException
key
- property key
SerializerException
- serializer exceptionpublic static SerializerException error(java.lang.Object key, java.lang.String found, java.lang.String... allowed) throws SerializerException
key
- property keyfound
- found valueallowed
- allowed values
SerializerException
- serializer exceptionpublic static java.lang.String allowed(java.lang.Object key, java.lang.String found, java.lang.String... allowed)
key
- property keyfound
- found valueallowed
- allowed values
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |