com.ctc.wstx.api
Class WstxOutputProperties

java.lang.Object
  extended by com.ctc.wstx.api.WstxOutputProperties

public final class WstxOutputProperties
extends java.lang.Object

Class that contains constant for property names used to configure cursor and event writers produced by Wstx implementation of XMLOutputFactory.


Field Summary
static java.lang.String DEFAULT_OUTPUT_ENCODING
          If no encoding is passed, we should just default to what xml in general expects (and can determine), UTF-8.
static java.lang.String DEFAULT_XML_VERSION
          Default xml version number output, if none was specified by application.
static java.lang.String P_COPY_DEFAULT_ATTRS
          Whether writer should copy attributes that were initially expanded using default settings ("implicit" attributes) or not.
static java.lang.String P_OUTPUT_CDATA_AS_TEXT
          Whether writer should just automatically convert all calls that would normally produce CDATA to produce (quoted) text.
static java.lang.String P_OUTPUT_ESCAPE_CR
          Property that determines whether Carriage Return (\r) characters are to be escaped when output or not.
static java.lang.String P_OUTPUT_FIX_CONTENT
          Property that further modifies handling of invalid content so that if P_OUTPUT_VALIDATE_CONTENT is enabled, instead of reporting an error, writer will try to fix the problem.
static java.lang.String P_OUTPUT_UNDERLYING_STREAM
          Property that can be used to find out the underlying OutputStream that an XMLStreamWriter instance is using, if known (not known if constructed with a Writer, or other non-stream destination).
static java.lang.String P_OUTPUT_UNDERLYING_WRITER
          Property that can be used to find out the underlying Writer that an XMLStreamWriter instance is using, if known (may not be known if constructed with a OutputStream, or other non-Writer destination).
static java.lang.String P_OUTPUT_VALIDATE_ATTR
          Whether output classes should check uniqueness of attribute names, to prevent accidental output of duplicate attributes.
static java.lang.String P_OUTPUT_VALIDATE_CONTENT
          Whether output classes should do basic verification that the textual content output as part of nodes should be checked for validity, if there's a possibility of invalid content.
static java.lang.String P_OUTPUT_VALIDATE_NAMES
          Whether output classes should check validity of names, ie that they only contain legal XML identifier characters.
static java.lang.String P_OUTPUT_VALIDATE_STRUCTURE
          Whether output classes should do basic verification that the output structure is well-formed (start and end elements match); that there is one and only one root, and that there is no textual content in prolog/epilog.
 
Constructor Summary
WstxOutputProperties()
           
 
Method Summary
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_XML_VERSION

public static final java.lang.String DEFAULT_XML_VERSION
Default xml version number output, if none was specified by application. Version 1.0 is used to try to maximize compatibility (some older parsers may barf on 1.1 and later...)

See Also:
Constant Field Values

DEFAULT_OUTPUT_ENCODING

public static final java.lang.String DEFAULT_OUTPUT_ENCODING
If no encoding is passed, we should just default to what xml in general expects (and can determine), UTF-8.

Note: you can check out bug entry [WSTX-18] for more details

See Also:
Constant Field Values

P_OUTPUT_CDATA_AS_TEXT

public static final java.lang.String P_OUTPUT_CDATA_AS_TEXT
Whether writer should just automatically convert all calls that would normally produce CDATA to produce (quoted) text.

See Also:
Constant Field Values

P_COPY_DEFAULT_ATTRS

public static final java.lang.String P_COPY_DEFAULT_ATTRS
Whether writer should copy attributes that were initially expanded using default settings ("implicit" attributes) or not.

See Also:
Constant Field Values

P_OUTPUT_VALIDATE_STRUCTURE

public static final java.lang.String P_OUTPUT_VALIDATE_STRUCTURE
Whether output classes should do basic verification that the output structure is well-formed (start and end elements match); that there is one and only one root, and that there is no textual content in prolog/epilog. If false, won't do any checking regarding structure.

See Also:
Constant Field Values

P_OUTPUT_VALIDATE_CONTENT

public static final java.lang.String P_OUTPUT_VALIDATE_CONTENT
Whether output classes should do basic verification that the textual content output as part of nodes should be checked for validity, if there's a possibility of invalid content. Nodes that include such constraints are: comment/'--', cdata/']]>', proc. instr/'?>'.

See Also:
Constant Field Values

P_OUTPUT_VALIDATE_ATTR

public static final java.lang.String P_OUTPUT_VALIDATE_ATTR
Whether output classes should check uniqueness of attribute names, to prevent accidental output of duplicate attributes.

See Also:
Constant Field Values

P_OUTPUT_VALIDATE_NAMES

public static final java.lang.String P_OUTPUT_VALIDATE_NAMES
Whether output classes should check validity of names, ie that they only contain legal XML identifier characters.

See Also:
Constant Field Values

P_OUTPUT_FIX_CONTENT

public static final java.lang.String P_OUTPUT_FIX_CONTENT
Property that further modifies handling of invalid content so that if P_OUTPUT_VALIDATE_CONTENT is enabled, instead of reporting an error, writer will try to fix the problem. Invalid content in this context refers to comment content with "--", CDATA with "]]>" and proc. instr data with "?>". This can be done for some content (CDATA, possibly comment), by splitting content into separate segments; but not for others (proc. instr, since that might change the semantics in unintended ways).

See Also:
Constant Field Values

P_OUTPUT_ESCAPE_CR

public static final java.lang.String P_OUTPUT_ESCAPE_CR
Property that determines whether Carriage Return (\r) characters are to be escaped when output or not. If enabled, all instances of of character \r are escaped using a character entity (where possible, that is, within CHARACTERS events, and attribute values). Otherwise they are output as is. The main reason to enable this property is to ensure that carriage returns are preserved as is through parsing, since otherwise they will be converted to canonical xml linefeeds (\n), when occuring along or as part of \r\n pair.

See Also:
Constant Field Values

P_OUTPUT_UNDERLYING_STREAM

public static final java.lang.String P_OUTPUT_UNDERLYING_STREAM
Property that can be used to find out the underlying OutputStream that an XMLStreamWriter instance is using, if known (not known if constructed with a Writer, or other non-stream destination). Null is returned, if not known.

Note: in general it is dangerous to operate on returned stream (if any), due to buffering stream writer can do. As such, caller has to take care to know what he is doing, including properly flushing output.

See Also:
Constant Field Values

P_OUTPUT_UNDERLYING_WRITER

public static final java.lang.String P_OUTPUT_UNDERLYING_WRITER
Property that can be used to find out the underlying Writer that an XMLStreamWriter instance is using, if known (may not be known if constructed with a OutputStream, or other non-Writer destination). Null is returned, if not known. Note that the Writer may be an internal wrapper over an output stream.

Note: in general it is dangerous to operate on returned Writer (if any), due to buffering stream writer can do. As such, caller has to take care to know what he is doing, including properly flushing output.

See Also:
Constant Field Values
Constructor Detail

WstxOutputProperties

public WstxOutputProperties()