Package com.ctc.wstx.sw
Class SimpleOutputElement
java.lang.Object
com.ctc.wstx.sw.OutputElementBase
com.ctc.wstx.sw.SimpleOutputElement
- All Implemented Interfaces:
NamespaceContext
Class that encapsulates information about a specific element in virtual
output stack for namespace-aware writers.
It provides support for URI-to-prefix mappings as well as namespace
mapping generation.
One noteworthy feature of the class is that it is designed to allow "short-term recycling", ie. instances can be reused within context of a simple document output. While reuse/recycling of such lightweight object is often useless or even counter productive, here it may be worth using, due to simplicity of the scheme (basically using a very simple free-elements linked list).
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescription(package private) static final class
Simple key class used to represent two-piece (attribute) names; first part being optional (URI), and second non-optional (local name). -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected HashSet
<SimpleOutputElement.AttrName> Map used to check for duplicate attribute declarations, if feature is enabled.protected String
Local name of the element.protected SimpleOutputElement
Reference to the parent element, element enclosing this element.protected String
Prefix that is used for the element.protected String
Namespace of the element, whatevermPrefix
maps to.Fields inherited from class com.ctc.wstx.sw.OutputElementBase
DEFAULT_XML_BINDINGS, mDefaultNsURI, mNsMapping, mNsMapShared, mRootNsContext, PREFIX_MISBOUND, PREFIX_OK, PREFIX_UNBOUND, sXmlNsPrefix, sXmlNsURI
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
Constructor for the virtual root elementprivate
SimpleOutputElement
(SimpleOutputElement parent, String prefix, String localName, String uri, BijectiveNsMap ns) -
Method Summary
Modifier and TypeMethodDescriptionprotected void
addToPool
(SimpleOutputElement poolHead) Method called to temporarily link this instance to a pool, to allow reusing of instances with the same reader.void
checkAttrWrite
(String nsURI, String localName) protected SimpleOutputElement
createChild
(String localName) Simplest factory method, which gets called when a 1-argument element output method is called.protected SimpleOutputElement
createChild
(String prefix, String localName, String uri) Full factory method, used for 'normal' namespace qualified output methods.static SimpleOutputElement
getName()
boolean
isRoot()
private void
relink
(SimpleOutputElement parent, String prefix, String localName, String uri) Method called to reuse a pooled instance.protected SimpleOutputElement
reuseAsChild
(SimpleOutputElement parent, String localName) protected SimpleOutputElement
reuseAsChild
(SimpleOutputElement parent, String prefix, String localName, String uri) void
setDefaultNsUri
(String uri) void
protected final void
Note: this method can and will only be called before outputting the root element.Methods inherited from class com.ctc.wstx.sw.OutputElementBase
addPrefix, generateMapping, getDefaultNsUri, getExplicitPrefix, getNamespaceURI, getPrefix, getPrefixes, isPrefixValid, relink, throwOutputError
-
Field Details
-
mParent
Reference to the parent element, element enclosing this element. Null for root element. Non-final only to allow temporary pooling (on per-writer basis, to keep these short-lived). -
mPrefix
Prefix that is used for the element. Can not be final, since sometimes it needs to be dynamically generated and bound after creating the element instance. -
mLocalName
Local name of the element. Non-final only to allow reuse. -
mURI
Namespace of the element, whatevermPrefix
maps to. Non-final only to allow reuse. -
mAttrSet
Map used to check for duplicate attribute declarations, if feature is enabled.
-
-
Constructor Details
-
SimpleOutputElement
private SimpleOutputElement()Constructor for the virtual root element -
SimpleOutputElement
private SimpleOutputElement(SimpleOutputElement parent, String prefix, String localName, String uri, BijectiveNsMap ns)
-
-
Method Details
-
relink
Method called to reuse a pooled instance. -
createRoot
-
createChild
Simplest factory method, which gets called when a 1-argument element output method is called. It is, then, assumed to use the default namespce. -
reuseAsChild
- Returns:
- New head of the recycle pool
-
reuseAsChild
protected SimpleOutputElement reuseAsChild(SimpleOutputElement parent, String prefix, String localName, String uri) -
createChild
Full factory method, used for 'normal' namespace qualified output methods. -
addToPool
Method called to temporarily link this instance to a pool, to allow reusing of instances with the same reader. -
getParent
-
isRoot
public boolean isRoot()- Specified by:
isRoot
in classOutputElementBase
-
getNameDesc
- Specified by:
getNameDesc
in classOutputElementBase
- Returns:
- String presentation of the fully-qualified name, in "prefix:localName" format (no URI). Useful for error and debugging messages.
-
getPrefix
-
getLocalName
-
getNamespaceURI
-
getName
-
checkAttrWrite
- Throws:
XMLStreamException
-
setPrefix
-
setDefaultNsUri
- Specified by:
setDefaultNsUri
in classOutputElementBase
-
setRootNsContext
Note: this method can and will only be called before outputting the root element.- Specified by:
setRootNsContext
in classOutputElementBase
-