org.codehaus.staxmate.out

Class SMOCharacters

java.lang.Object

org.codehaus.staxmate.out.SMOutputtable

org.codehaus.staxmate.out.SMOCharacters

public abstract class SMOCharacters
extends SMOutputtable

Field Summary

Fields inherited from class org.codehaus.staxmate.out.SMOutputtable

_next

Method Summary

Methods

Modifier and Type	Method and Description
protected void	_forceOutput(SMOutputContext ctxt) Method similar to SMOutputtable._output(org.codehaus.staxmate.out.SMOutputContext, boolean), except that this method will always succeed in doing the output.
protected abstract boolean	_output(SMOutputContext ctxt, boolean canClose) Method called to request that the entity output itself; either as much as it can without closing, or as much as it can if it is to get closed.
static SMOutputtable	create(String text)
static SMOutputtable	createNonShared(char[] buf, int offset, int len)
static SMOutputtable	createShared(char[] buf, int offset, int len)

Methods inherited from class org.codehaus.staxmate.out.SMOutputtable

_linkNext, getNext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static SMOutputtable create(String text)

createShared

public static SMOutputtable createShared(char[] buf,
                         int offset,
                         int len)

createNonShared

public static SMOutputtable createNonShared(char[] buf,
                            int offset,
                            int len)

_output

protected abstract boolean _output(SMOutputContext ctxt,
              boolean canClose)
                            throws XMLStreamException

Description copied from class: SMOutputtable

Method called to request that the entity output itself; either as much as it can without closing, or as much as it can if it is to get closed. In both cases output can fail or be only a partial one: buffered nodes will not be output at all, and nodes with buffered children can only be partially output.

Parameters:

ctxt - Output context to use for outputting this node (and its contents)

canClose - If true, indicates that the node can (and should) be fully closed if possible. This (passing true) is usually done when a new sibling is added after a node (element/fragment); if so, current one should be recursively closed. If false, should only try to output as much as can be done without forcing closures.

Returns:

True if the whole node could be output, ie. neither it nor its children are buffered.

Throws:

XMLStreamException

_forceOutput

protected void _forceOutput(SMOutputContext ctxt)
                     throws XMLStreamException

Description copied from class: SMOutputtable

Method similar to SMOutputtable._output(org.codehaus.staxmate.out.SMOutputContext, boolean), except that this method will always succeed in doing the output. Specifically, it will force all buffered nodes to be unbuffered, and then output.

Specified by:

_forceOutput in class SMOutputtable

Throws:

XMLStreamException