com.ibm.portal.resolver.xml
Interface XMLStreamHandler

public interface XMLStreamHandler

Callback interface similar to ContentHandler that allows for an efficient serialization of hierarchical markup. The main advantage over the ContentHandler is that the attribute declarations can be streamed and do not need to be prepared as strings.

Since:

8.0.0.1

Field Summary

static java.lang.String	ATTR_TYPE_CDATA
static java.lang.String	ATTR_TYPE_ENTITIES
static java.lang.String	ATTR_TYPE_ENTITY
static java.lang.String	ATTR_TYPE_ID
static java.lang.String	ATTR_TYPE_IDREF
static java.lang.String	ATTR_TYPE_IDREFS
static java.lang.String	ATTR_TYPE_NMTOKEN
static java.lang.String	ATTR_TYPE_NMTOKENS
static java.lang.String	ATTR_TYPE_NOTATION

Method Summary

void	characters(char[] cbuf, int off, int len) Writes characters, depending on the enclosing element this is either the value of an attribute or the character data of an element.
void	characters(java.lang.String cbuf, int off, int len) Writes characters, depending on the enclosing element this is either the value of an attribute or the character data of an element.
void	endAttribute() Ends the serialization of an attribute
void	endDocument() Indicates the end of the serialization process
void	endElement() Ends the previously opened element
void	startAttribute(java.lang.String qName, java.lang.String type) Starts an attribute, namespace declarations need to be represented as attributes
void	startDocument() Indicates the beginning of the serialization process
void	startElement(java.lang.String qName) Starts an element

Field Detail

ATTR_TYPE_CDATA

static final java.lang.String ATTR_TYPE_CDATA

See Also:

Constants.ATTR_TYPE_CDATA, Constant Field Values

ATTR_TYPE_ID

static final java.lang.String ATTR_TYPE_ID

See Also:

Constants.ATTR_TYPE_ID, Constant Field Values

ATTR_TYPE_IDREF

static final java.lang.String ATTR_TYPE_IDREF

See Also:

Constants.ATTR_TYPE_IDREF, Constant Field Values

ATTR_TYPE_IDREFS

static final java.lang.String ATTR_TYPE_IDREFS

See Also:

Constants.ATTR_TYPE_IDREFS, Constant Field Values

ATTR_TYPE_NMTOKEN

static final java.lang.String ATTR_TYPE_NMTOKEN

See Also:

Constants.ATTR_TYPE_NMTOKEN, Constant Field Values

ATTR_TYPE_NMTOKENS

static final java.lang.String ATTR_TYPE_NMTOKENS

See Also:

Constants.ATTR_TYPE_NMTOKENS, Constant Field Values

ATTR_TYPE_ENTITY

static final java.lang.String ATTR_TYPE_ENTITY

See Also:

Constants.ATTR_TYPE_ENTITY, Constant Field Values

ATTR_TYPE_ENTITIES

static final java.lang.String ATTR_TYPE_ENTITIES

See Also:

Constant Field Values

ATTR_TYPE_NOTATION

static final java.lang.String ATTR_TYPE_NOTATION

See Also:

Constants.ATTR_TYPE_NOTATION, Constant Field Values

Method Detail

characters

void characters(char[] cbuf,
                int off,
                int len)
                throws java.io.IOException

Writes characters, depending on the enclosing element this is either the value of an attribute or the character data of an element.

Parameters:

cbuf - the character buffer

off - first index into the buffer

len - length of the data in the buffer

Throws:

java.io.IOException

characters

void characters(java.lang.String cbuf,
                int off,
                int len)
                throws java.io.IOException

Writes characters, depending on the enclosing element this is either the value of an attribute or the character data of an element.

Parameters:

cbuf - the string

off - first index into the buffer

len - length of the data in the buffer

Throws:

java.io.IOException

endAttribute

void endAttribute()
                  throws java.io.IOException

Ends the serialization of an attribute

Throws:

java.io.IOException

endDocument

void endDocument()
                 throws java.io.IOException

Indicates the end of the serialization process

Throws:

java.io.IOException

endElement

void endElement()
                throws java.io.IOException

Ends the previously opened element

Throws:

java.io.IOException

startAttribute

void startAttribute(java.lang.String qName,
                    java.lang.String type)
                    throws java.io.IOException

Starts an attribute, namespace declarations need to be represented as attributes

Parameters:

qName - the qname of the attribute

type - the type of the attribute if known, else null. The selection of the correct attribute type has performance implications since a more efficient serializer can be used for non CDATA types.

Throws:

java.io.IOException

See Also:

#ATTR_TYPE_CDATA}, #ATTR_TYPE_ID}, #ATTR_TYPE_IDREF}, #ATTR_TYPE_IDREFS}, #ATTR_TYPE_NMTOKEN}, #ATTR_TYPE_NMTOKENS}, #ATTR_TYPE_ENTITY}, #ATTR_TYPE_ENTITIES}, #ATTR_TYPE_NOTATION}

startDocument

void startDocument()
                   throws java.io.IOException

Indicates the beginning of the serialization process

Throws:

java.io.IOException

startElement

void startElement(java.lang.String qName)
                  throws java.io.IOException

Starts an element

Parameters:

qName - the qname of the element, namespace handling must be done explicitly

Throws:

java.io.IOException