com.ibm.portal.resolver.xml
Interface StreamContentHandler

All Superinterfaces:

CharsetHandler, org.xml.sax.ContentHandler, java.io.Flushable

public interface StreamContentHandler
extends org.xml.sax.ContentHandler, CharsetHandler, java.io.Flushable

An implementation of a ContentHandler that serializes XML into a stream

Since:

6.1.0.2

Field Summary

static java.lang.String	DISABLE_OUTPUT_ESCAPING Processing instruction to disable output escaping when writing characters using the ContentHandler.processingInstruction(String, String) method.
static java.lang.String	ENABLE_OUTPUT_ESCAPING Processing instruction to enable output escaping when writing characters using the ContentHandler.processingInstruction(String, String) method.
static java.lang.String	INDENT specifies if the handler indents the output
static java.lang.String	INDENT_NO disables indention
static java.lang.String	INDENT_YES enables indention
static java.lang.String	OUTPUT_ESCAPING_DATA Data passed to the ContentHandler.processingInstruction(String, String) to enable or disable output escaping

Method Summary

java.util.Properties	getOutputProperties() Returns the current output properties
java.lang.String	getOutputProperty(java.lang.String name) Returns one particular output property
java.nio.charset.Charset	setCharset(java.nio.charset.Charset charset) Assigns the characterset used for the output
void	setOutputProperties(java.util.Properties oformat) Assigns a new set of properties.
void	setOutputProperty(java.lang.String name, java.lang.String value) Assigns a new property that handles the target serialization
java.io.OutputStream	setOutputStream(java.io.OutputStream out) Sets the OutputStream to serialize to
java.io.Writer	setWriter(java.io.Writer out) Sets the Writer to serialize to

Methods inherited from interface org.xml.sax.ContentHandler

characters, endDocument, endElement, endPrefixMapping, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startDocument, startElement, startPrefixMapping

Methods inherited from interface java.io.Flushable

flush

Field Detail

DISABLE_OUTPUT_ESCAPING

static final java.lang.String DISABLE_OUTPUT_ESCAPING

Processing instruction to disable output escaping when writing characters using the ContentHandler.processingInstruction(String, String) method.

Since:

8.0

See Also:

ContentHandler.processingInstruction(String, String), OUTPUT_ESCAPING_DATA, Constant Field Values

ENABLE_OUTPUT_ESCAPING

static final java.lang.String ENABLE_OUTPUT_ESCAPING

Processing instruction to enable output escaping when writing characters using the ContentHandler.processingInstruction(String, String) method.

Since:

8.0

See Also:

ContentHandler.processingInstruction(String, String), OUTPUT_ESCAPING_DATA, Constant Field Values

OUTPUT_ESCAPING_DATA

static final java.lang.String OUTPUT_ESCAPING_DATA

Data passed to the ContentHandler.processingInstruction(String, String) to enable or disable output escaping

Since:

8.0

See Also:

Constant Field Values

INDENT

static final java.lang.String INDENT

specifies if the handler indents the output

Since:

7.0

See Also:

setOutputProperty(String, String), Constant Field Values

INDENT_YES

static final java.lang.String INDENT_YES

enables indention

Since:

7.0

See Also:

INDENT, setOutputProperty(String, String), Constant Field Values

INDENT_NO

static final java.lang.String INDENT_NO

disables indention

Since:

7.0

See Also:

INDENT, setOutputProperty(String, String), Constant Field Values

Method Detail

getOutputProperties

java.util.Properties getOutputProperties()

Returns the current output properties

Returns:

the output properties

See Also:

Transformer#getOutputProperties()}

getOutputProperty

java.lang.String getOutputProperty(java.lang.String name)
                                   throws java.lang.IllegalArgumentException

Returns one particular output property

Parameters:

name - name of the property

Returns:

value of the property or null

Throws:

java.lang.IllegalArgumentException

See Also:

Transformer#getOutputProperty(String)}

setCharset

java.nio.charset.Charset setCharset(java.nio.charset.Charset charset)

Assigns the characterset used for the output

Specified by:

setCharset in interface CharsetHandler

Parameters:

charset - the new characterset

Returns:

the previous characterset

setOutputProperties

void setOutputProperties(java.util.Properties oformat)
                         throws java.lang.IllegalArgumentException

Assigns a new set of properties.

Parameters:

oformat - the properties

Throws:

java.lang.IllegalArgumentException

See Also:

Transformer#setOutputProperties(Properties)}

setOutputProperty

void setOutputProperty(java.lang.String name,
                       java.lang.String value)
                       throws java.lang.IllegalArgumentException

Assigns a new property that handles the target serialization

Parameters:

name - name of the property

value - value of the property

Throws:

java.lang.IllegalArgumentException

See Also:

Transformer#setOutputProperty(String, String)}

setOutputStream

java.io.OutputStream setOutputStream(java.io.OutputStream out)

Sets the OutputStream to serialize to

Parameters:

out - target stream

Returns:

the previously assigned stream

setWriter

java.io.Writer setWriter(java.io.Writer out)

Sets the Writer to serialize to

Parameters:

out - target writer

Returns:

the previously assigned writer