Package org.apache.axiom.om.util

Class StAXUtils

  • public class StAXUtils
extends Object
    Utility class containing StAX related methods.

    This class defines a set of methods to get XMLStreamReader and XMLStreamWriter instances. This class caches the corresponding factories, i.e. XMLInputFactory and XMLOutputFactory objects.

    Default properties for these factories can be specified using XMLInputFactory.properties and XMLOutputFactory.properties files. These files are loaded using the class loader that loaded the StAXUtils class. Properties with boolean, integer and string values are supported. Both standard StAX properties and implementation specific properties can be specified. This feature should be used with care since changing some properties to non default values will break Axiom. Good candidates for XMLInputFactory.properties are:

    javax.xml.stream.isCoalescing
    Requires the processor to coalesce adjacent character data (text nodes and CDATA sections). This property also controls whether CDATA sections are reported or not.
    com.ctc.wstx.inputBufferLength
    Size of input buffer (in chars), to use for reading XML content from input stream/reader. This property is Woodstox specific.
    com.ctc.wstx.minTextSegment
    Property to specify shortest non-complete text segment (part of CDATA section or text content) that the parser is allowed to return, if not required to coalesce text. This property is Woodstox specific.

    Good candidates for XMLOutputFactory.properties are:

    com.ctc.wstx.outputEscapeCr
    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 occurring along or as part of \r\n pair. This property is Woodstox specific.