org.codehaus.staxmate.out

Class SMOutputElement

java.lang.Object

org.codehaus.staxmate.out.SMOutputtable

org.codehaus.staxmate.out.SMOutputContainer

org.codehaus.staxmate.out.SMOutputElement

Direct Known Subclasses:

SMBufferedElement

public class SMOutputElement
extends SMOutputContainer

Output class that models an outputtable XML element.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	_localName Local name of the element, name without preceding prefix or colon (in namespace mode).
protected SMNamespace	_namespace Namespace of this element.
protected int	_outputState
protected SMNamespace	_parentDefaultNs Namespace that was bound as the default namespace in the context where this element gets output.
protected int	_parentNsCount Number of explicitly bound namespaces parent element has (or for root elements 0).
protected static int	OUTPUT_ATTRS
protected static int	OUTPUT_CHILDREN
protected static int	OUTPUT_CLOSED
protected static int	OUTPUT_NONE

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

_context, _firstChild, _lastChild, _parent

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

_next

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SMOutputElement(SMOutputContext ctxt, String localName, SMNamespace ns)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	_canOutputNewChild() Method called to figure out if we can just output a newly added child, without any buffering.
protected void	_childReleased(SMOutputtable child) Method called by a child, when it is released and neither is or contains any buffered entities.
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 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.
protected void	_throwClosedForAttrs() Method for indicating illegal call to add attributes, when the underlying stream state prevents addition.
protected void	_throwClosedForNsDecls()
void	addAttribute(SMNamespace ns, String localName, boolean value) Typed Access write method to use for adding attribute with boolean value.
SMOutputElement	addAttribute(SMNamespace ns, String localName, byte[] value) Typed Access write method to use for adding attribute with base64-encoded binary value using appropriate default variant (MIME, no linefeeds)
void	addAttribute(SMNamespace ns, String localName, int value) Typed Access write method to use for adding attribute with integer value.
void	addAttribute(SMNamespace ns, String localName, long value) Typed Access write method to use for adding attribute with long value.
void	addAttribute(SMNamespace ns, String localName, String value) Method for adding an attribute to this element.
SMOutputElement	addAttribute(String localName, byte[] value) Typed Access write method to use for adding attribute with base64-encoded binary value using appropriate default variant (MIME, no linefeeds)
void	addAttribute(String localName, String value) Convenience method for attributes that do not belong to a namespace (no prefix)
protected void	doWriteEndElement()
protected void	doWriteStartElement()
String	getLocalName() Method that can be used to get the local name of this element
SMNamespace	getNamespace() Method that can be used to get the namespace of the element.
void	getPath(StringBuilder sb) Method that can be called to get an XPath like description of the relative location of this output node, starting from root.
void	linkParent(SMOutputContainer parent, boolean blocked)
void	predeclareNamespace(SMNamespace ns) Method that can be (but never has to) called to force declaration of given namespace for this element, if that is possible (i.e.

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

_closeAllButLastChild, _closeAndOutputChildren, _forceChildOutput, _linkNewChild, _throwClosed, _throwRelinking, _verifyNamespaceArg, addAndReleaseBuffered, addBuffered, addCData, addCData, addCharacters, addCharacters, addComment, addElement, addElement, addElementWithCharacters, addEntityRef, addProcessingInstruction, addValue, addValue, addValue, addValue, addValue, addValue, createBufferedElement, createBufferedFragment, getContext, getNamespace, getNamespace, getParent, getPath, setIndentation

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

Field Detail

OUTPUT_NONE

protected static final int OUTPUT_NONE

See Also:

Constant Field Values

OUTPUT_ATTRS

protected static final int OUTPUT_ATTRS

See Also:

Constant Field Values

OUTPUT_CHILDREN

protected static final int OUTPUT_CHILDREN

See Also:

Constant Field Values

OUTPUT_CLOSED

protected static final int OUTPUT_CLOSED

See Also:

Constant Field Values

_localName

protected final String _localName

Local name of the element, name without preceding prefix or colon (in namespace mode). In non-namespace mode fully-qualified name.

_namespace

protected final SMNamespace _namespace

Namespace of this element.

Note: can never be null -- event the default (empty) namespace is presented by a global shared namespace instance.

_outputState

protected int _outputState

_parentDefaultNs

protected SMNamespace _parentDefaultNs

Namespace that was bound as the default namespace in the context where this element gets output. This is generally just stored here to be able to write the end element matching start element, since it's SMOutputContext that handles actual namespace binding for output. This is either the default declared namespace of an ancestor element, or if none exists, the default namespace of the root (either the empty namespace, or one found via NamespaceContext.

Note: can never be null -- event the default (empty) namespace is presented by a global shared namespace instance.

_parentNsCount

protected int _parentNsCount

Number of explicitly bound namespaces parent element has (or for root elements 0). Stored for SMOutputContext during time element is open; needed for closing namespace scopes appropriately.

Constructor Detail

SMOutputElement

protected SMOutputElement(SMOutputContext ctxt,
               String localName,
               SMNamespace ns)

Method Detail

linkParent

public void linkParent(SMOutputContainer parent,
              boolean blocked)
                throws XMLStreamException

Throws:

XMLStreamException

getLocalName

public String getLocalName()

Method that can be used to get the local name of this element

getNamespace

public SMNamespace getNamespace()

Method that can be used to get the namespace of the element. Note that the returned value is never null; if no namespace was passed during construction, "no namespace" (SMOutputContext.getEmptyNamespace()) is used instead.

Returns:

Namespace of this element.

addAttribute

public void addAttribute(SMNamespace ns,
                String localName,
                String value)
                  throws XMLStreamException

Method for adding an attribute to this element. For regular (non-buffered) output elements, attribute is written right away; for buffered variants output will be postponed until buffered element is completely released (including its ancestors if they are unreleased buffered elements)

Throws:

XMLStreamException

addAttribute

public final void addAttribute(String localName,
                String value)
                        throws XMLStreamException

Convenience method for attributes that do not belong to a namespace (no prefix)

Throws:

XMLStreamException

addAttribute

public void addAttribute(SMNamespace ns,
                String localName,
                boolean value)
                  throws XMLStreamException

Typed Access write method to use for adding attribute with boolean value.

Throws:

XMLStreamException

addAttribute

public void addAttribute(SMNamespace ns,
                String localName,
                int value)
                  throws XMLStreamException

Typed Access write method to use for adding attribute with integer value.

Throws:

XMLStreamException

addAttribute

public void addAttribute(SMNamespace ns,
                String localName,
                long value)
                  throws XMLStreamException

Typed Access write method to use for adding attribute with long value.

Throws:

XMLStreamException

addAttribute

public SMOutputElement addAttribute(SMNamespace ns,
                           String localName,
                           byte[] value)
                             throws XMLStreamException

Typed Access write method to use for adding attribute with base64-encoded binary value using appropriate default variant (MIME, no linefeeds)

Returns:

This element, to allow call chaining

Throws:

XMLStreamException

Since:

2.0

addAttribute

public SMOutputElement addAttribute(String localName,
                           byte[] value)
                             throws XMLStreamException

Typed Access write method to use for adding attribute with base64-encoded binary value using appropriate default variant (MIME, no linefeeds)

Returns:

This element, to allow call chaining

Throws:

XMLStreamException

Since:

2.0

predeclareNamespace

public void predeclareNamespace(SMNamespace ns)
                         throws XMLStreamException

Method that can be (but never has to) called to force declaration of given namespace for this element, if that is possible (i.e. no binding has been added for the preferred prefix of given namespace). This is usually done as a minor optimization or cosmetic improvement so that child elements need not declare the namespace. Since namespace declarations are otherwise output automatically when and as needed, this method never has to be called (from correctness standpoint), but it may produce more aestethically pleasing and compact output when properly used.

Default namespace can often not be pre-declared using this method, because that would change namespace of the element itself if it has no prefix, so method is most often called for namespaces with explicit prefix.

Note: in cases where the given namespace can not be bound to preferred URI, exact behavior is undefined: two possible outcomes are that no namespace declaration is added, or that one with different prefix (but given namespace URI) is added. No error is reported at any rate.

Throws:

XMLStreamException

Since:

2.0.0

_childReleased

protected void _childReleased(SMOutputtable child)
                       throws XMLStreamException

Description copied from class: SMOutputContainer

Method called by a child, when it is released and neither is or contains any buffered entities. This should indicate that it can be output unless one of its parents or preceding siblings is buffered. Container is expected to update its own state, and then inform its own parent (if necesary) about release; this may cascade output from parents up the container stack.

Specified by:

_childReleased in class SMOutputContainer

Parameters:

child - Child node that now neither is nor contains any buffered nodes.

Throws:

XMLStreamException

_output

protected 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.

Specified by:

_output in class SMOutputContainer

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 SMOutputContainer

Throws:

XMLStreamException

_canOutputNewChild

public boolean _canOutputNewChild()
                           throws XMLStreamException

Description copied from class: SMOutputContainer

Method called to figure out if we can just output a newly added child, without any buffering. It will request container to close and output all non-buffered children it has, if any; and indicate whether it was fully succesful or not.

Specified by:

_canOutputNewChild in class SMOutputContainer

Returns:

True if all children (if any) were completely output; false if there was at least one buffered child that couldn't be output.

Throws:

XMLStreamException

getPath

public void getPath(StringBuilder sb)

Description copied from class: SMOutputContainer

Method that can be called to get an XPath like description of the relative location of this output node, starting from root. Path will be appended to given StringBuilder.

Specified by:

getPath in class SMOutputContainer

doWriteStartElement

protected void doWriteStartElement()
                            throws XMLStreamException

Throws:

XMLStreamException

doWriteEndElement

protected void doWriteEndElement()
                          throws XMLStreamException

Throws:

XMLStreamException

_throwClosedForAttrs

protected void _throwClosedForAttrs()

Method for indicating illegal call to add attributes, when the underlying stream state prevents addition.

_throwClosedForNsDecls

protected void _throwClosedForNsDecls()