public class OMElementImpl extends OMNodeImpl implements IElement, OMConstants
Modifier and Type | Field and Description |
---|---|
protected HashMap |
attributes
Field attributes
|
protected OMXMLParserWrapper |
builder |
protected OMNode |
firstChild
Field firstChild
|
protected OMNode |
lastChild |
protected String |
localName
Field localName
|
protected HashMap |
namespaces
Field namespaces
|
protected OMNamespace |
ns
The namespace of this element.
|
protected QName |
qName |
protected int |
state |
nextSibling, parent, previousSibling
factory
COMPLETE, DISCARDED, INCOMPLETE
CDATA_SECTION_NODE, COMMENT_NODE, DTD_NODE, ELEMENT_NODE, ENTITY_REFERENCE_NODE, PI_NODE, SPACE_NODE, TEXT_NODE
ARRAY_ITEM_LOCALNAME, ARRAY_ITEM_NS_PREFIX, ARRAY_ITEM_NSURI, ARRAY_ITEM_QNAME, DATA_HANDLER, DEFAULT_CHAR_SET_ENCODING, DEFAULT_DEFAULT_NAMESPACE, DEFAULT_XML_VERSION, IS_BINARY, IS_DATA_HANDLERS_AWARE, PULL_TYPE_BUILDER, PUSH_TYPE_BUILDER, XMLATTRTYPE_CDATA, XMLATTRTYPE_ENTITIES, XMLATTRTYPE_ENTITY, XMLATTRTYPE_ID, XMLATTRTYPE_IDREF, XMLATTRTYPE_IDREFS, XMLATTRTYPE_NMTOKEN, XMLATTRTYPE_NMTOKENS, XMLATTRTYPE_NOTATION, XMLNS_NS_PREFIX, XMLNS_NS_URI, XMLNS_PREFIX, XMLNS_URI
Constructor and Description |
---|
OMElementImpl(OMContainer parent,
String localName,
OMNamespace ns,
OMXMLParserWrapper builder,
OMFactory factory,
boolean generateNSDecl) |
OMElementImpl(QName qname,
OMContainer parent,
OMFactory factory)
It is assumed that the QName passed contains, at least, the localName for this element.
|
Modifier and Type | Method and Description |
---|---|
OMAttribute |
addAttribute(OMAttribute attr)
Inserts an attribute to this element.
|
OMAttribute |
addAttribute(String attributeName,
String value,
OMNamespace ns)
Adds an attribute to this element.
|
void |
addChild(OMNode omNode)
Adds the given node as the last child of this container.
|
void |
addChild(OMNode omNode,
boolean fromBuilder) |
OMNamespace |
addNamespaceDeclaration(String uri,
String prefix)
Adds a namespace declaration without doing any additional checks.
|
void |
build()
Builds itself.
|
void |
buildWithAttachments()
Parses this node and builds the object structure in memory.
|
OMElement |
cloneOMElement()
Clones this element and its descendants using default options.
|
protected OMElement |
createClone(OMCloneOptions options,
OMContainer targetParent) |
OMNamespace |
declareDefaultNamespace(String uri)
Add a namespace declaration for the default namespace to this element.
|
OMNamespace |
declareNamespace(OMNamespace namespace)
Declares a namespace with the element as its scope.
|
OMNamespace |
declareNamespace(String uri,
String prefix)
Add a namespace declaration for the given namespace URI to this element, optionally
generating a prefix for that namespace.
|
OMNode |
detach()
Removes this information item and its children, from the model completely.
|
void |
discard()
Method discard.
|
void |
discarded() |
OMNamespace |
findNamespace(String uri,
String prefix)
Finds a namespace with the given uri and prefix, in the scope of the document.
|
OMNamespace |
findNamespaceURI(String prefix)
Checks for a namespace in the context of this element with the given prefix and returns the
relevant namespace object, if available.
|
Iterator |
getAllAttributes()
Returns a List of OMAttributes.
|
Iterator |
getAllDeclaredNamespaces()
Method getAllDeclaredNamespaces.
|
OMAttribute |
getAttribute(QName qname)
Returns a named attribute if present.
|
String |
getAttributeValue(QName qname)
Returns a named attribute's value, if present.
|
OMXMLParserWrapper |
getBuilder()
Method getBuilder.
|
Iterator |
getChildElements()
Returns a filtered list of children - just the elements.
|
Iterator |
getChildren()
Returns a collection of this element.
|
Iterator |
getChildrenWithLocalName(String localName)
Returns an iterator for child nodes matching the local name.
|
Iterator |
getChildrenWithName(QName elementQName)
Searches for children with a given QName and returns an iterator to traverse through the
OMNodes.
|
Iterator |
getChildrenWithNamespaceURI(String uri)
Returns an iterator for child nodes matching the namespace uri.
|
OMNamespace |
getDefaultNamespace()
Get the default namespace in scope on this element.
|
Iterator |
getDescendants(boolean includeSelf)
Get an iterator over all descendants of the container.
|
OMElement |
getFirstChildWithName(QName elementQName)
Method getFirstChildWithName.
|
OMElement |
getFirstElement()
Gets first element.
|
OMNode |
getFirstOMChild()
Method getFirstOMChild.
|
OMNode |
getFirstOMChildIfAvailable()
Get the first child if it is available.
|
OMNode |
getLastKnownOMChild() |
int |
getLineNumber() |
String |
getLocalName()
Method getLocalName.
|
OMNamespace |
getNamespace()
Get the namespace this information item is part of.
|
NamespaceContext |
getNamespaceContext(boolean detached)
Get the namespace context of this element, as determined by the namespace declarations
present on this element and its ancestors.
|
Iterator |
getNamespacesInScope()
Get an iterator that returns all namespaces in scope for this element.
|
String |
getNamespaceURI()
Get the namespace URI of this information item.
|
String |
getPrefix()
Get the prefix of this information item.
|
QName |
getQName()
Method getQName.
|
SAXSource |
getSAXSource(boolean cache)
Get a
SAXSource representation for this node. |
int |
getState() |
String |
getText()
Returns the non-empty text children as a string.
|
QName |
getTextAsQName()
Resolve the content of this element to a
QName . |
Reader |
getTextAsStream(boolean cache)
Returns a stream representing the concatenation of the text nodes that are children of a
this element.
|
int |
getType()
Returns the type of node.
|
XMLStreamReader |
getXMLStreamReader()
Get a pull parser representation of this element with caching enabled.
|
XMLStreamReader |
getXMLStreamReader(boolean cache)
Get a pull parser representation of this information item.
|
XMLStreamReader |
getXMLStreamReader(boolean cache,
OMXMLStreamReaderConfiguration configuration)
Get a pull parser representation of this information item.
|
XMLStreamReader |
getXMLStreamReaderWithoutCaching()
Get a pull parser representation of this element with caching disabled.
|
void |
internalSerialize(XMLStreamWriter writer,
boolean cache)
Serializes the node.
|
boolean |
isComplete()
Indicates whether parser has parsed this information item completely or not.
|
void |
removeAttribute(OMAttribute attr)
Removes the given attribute from this element.
|
void |
removeChildren()
Remove all children from this container.
|
QName |
resolveQName(String qname)
Resolves a QName literal in the namespace context defined by this element and produces a
corresponding
QName object. |
void |
setBuilder(OMXMLParserWrapper wrapper)
Method setBuilder.
|
void |
setComplete(boolean complete) |
void |
setFirstChild(OMNode firstChild)
Method setFirstChild.
|
void |
setLastChild(OMNode omNode)
forcefully set the last element in this parent element
|
void |
setLineNumber(int lineNumber) |
void |
setLocalName(String localName)
Method setLocalName.
|
void |
setNamespace(OMNamespace namespace)
Set the namespace for this element.
|
void |
setNamespaceWithNoFindInCurrentScope(OMNamespace namespace)
This will not search the namespace in the scope nor will declare in the current element, as
in setNamespace(OMNamespace).
|
void |
setText(QName qname)
Set the content of this element to the given
QName . |
void |
setText(String text)
Set the content of this element to the given text.
|
String |
toString()
Convenience method to serialize the element to a string with caching enabled.
|
String |
toStringWithConsume()
Convenience method to serialize the element to a string without caching.
|
void |
undeclarePrefix(String prefix)
Add a namespace declaration that undeclares a given prefix.
|
void |
writeTextTo(Writer out,
boolean cache)
Write the content of the text nodes that are children of a given element to a
Writer . |
clone, getIParentNode, getNextOMSibling, getNextOMSiblingIfAvailable, getParent, getPreviousOMSibling, insertSiblingAfter, insertSiblingBefore, internalSerialize, internalSerializeAndConsume, setNextOMSibling, setParent, setPreviousOMSibling
close, getOMFactory, serialize, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume
getIParentNode
getNextOMSiblingIfAvailable, internalSerialize, internalSerializeAndConsume, setNextOMSibling, setParent, setPreviousOMSibling
getNextOMSibling, getParent, getPreviousOMSibling, insertSiblingAfter, insertSiblingBefore
close, serialize, serialize, serializeAndConsume
clone, getOMFactory
protected OMXMLParserWrapper builder
protected int state
protected OMNamespace ns
null
(if the element has no namespace)
OMNamespace
instance, with the following exceptions:
OMNamespace
instance with a null
prefix
OMNamespace
instance with both prefix and namespace URI set to the empty
string
protected String localName
protected QName qName
protected OMNode firstChild
protected HashMap namespaces
protected HashMap attributes
protected OMNode lastChild
public OMElementImpl(OMContainer parent, String localName, OMNamespace ns, OMXMLParserWrapper builder, OMFactory factory, boolean generateNSDecl)
public OMElementImpl(QName qname, OMContainer parent, OMFactory factory) throws OMException
qname
- - this should be valid qname according to javax.xml.namespace.QNameOMException
public void addChild(OMNode omNode)
OMContainer
addChild
in interface OMContainer
omNode
- the node to be added to this containerpublic void addChild(OMNode omNode, boolean fromBuilder)
addChild
in interface OMContainerEx
public Iterator getChildrenWithName(QName elementQName)
getChildrenWithName
in interface OMContainer
elementQName
- The QName specifying namespace and local name to match.OMElement
items that match the given QNameOMException
public Iterator getChildrenWithLocalName(String localName)
OMContainer
getChildrenWithLocalName
in interface OMContainer
OMElement
items that match the given localNamepublic Iterator getChildrenWithNamespaceURI(String uri)
OMContainer
getChildrenWithNamespaceURI
in interface OMContainer
OMElement
items that match the given uripublic OMElement getFirstChildWithName(QName elementQName) throws OMException
getFirstChildWithName
in interface OMContainer
elementQName
- The QName to use for matching.qname
criteria, or null
if none is found.OMException
OMContainer.getChildrenWithName(QName)
public Iterator getChildren()
getChildren
in interface OMContainer
OMContainer.getFirstChildWithName(javax.xml.namespace.QName)
,
OMContainer.getChildrenWithName(javax.xml.namespace.QName)
public Iterator getDescendants(boolean includeSelf)
OMContainer
getDescendants
in interface OMContainer
includeSelf
- true
if the iterator should also return the container itself;
false
if the first item returned by the iterator should be the first
child of the containerpublic Iterator getChildElements()
getChildElements
in interface OMElement
OMContainer.getChildren()
,
OMContainer.getChildrenWithName(javax.xml.namespace.QName)
public OMNamespace declareNamespace(String uri, String prefix)
OMElement
Note that this method can't be used to declare a default namespace. For that purpose use
OMElement.declareDefaultNamespace(String)
or OMElement.declareNamespace(OMNamespace)
.
declareNamespace
in interface OMElement
uri
- The namespace to declare in the current scope. The caller is expected to ensure
that the URI is a valid namespace name.prefix
- The prefix to associate with the given namespace. The caller is expected to ensure
that this is a valid XML prefix. If null
or the empty string is
given, a prefix will be auto-generated. Please note that using the empty string
for this purpose is deprecated and will no longer be supported in Axiom 1.3.OMElement.declareNamespace(OMNamespace)
,
OMElement.findNamespace(String, String)
,
OMElement.getAllDeclaredNamespaces()
public OMNamespace declareDefaultNamespace(String uri)
OMElement
Note that this method will never change the namespace of the element itself. If an attempt is made to add a namespace declaration that conflicts with the namespace information of the element, an exception is thrown.
declareDefaultNamespace
in interface OMElement
uri
- The default namespace to declare in the current scope. The caller is expected to
ensure that the URI is a valid namespace name.public OMNamespace getDefaultNamespace()
OMElement
getDefaultNamespace
in interface OMElement
null
if no default namespace is in scope. This
method never returns an OMNamespace
object with an empty namespace URI; if
the element or one of its ancestors has a xmlns="" declaration, then
null
is returned. Note that if the method returns an OMNamespace
object, then its prefix will obviously be the empty string.public OMNamespace addNamespaceDeclaration(String uri, String prefix)
OMElementEx
In contrast to OMElement.declareNamespace(String, String)
this method can be used to
declare the default namespace.
addNamespaceDeclaration
in interface OMElementEx
uri
- the namespace to declare; must not be null
prefix
- the prefix to associate with the given namespace; must not be null
public OMNamespace declareNamespace(OMNamespace namespace)
OMElement
declareNamespace
in interface OMElement
namespace
- The namespace to declare. If the prefix specified by the OMNamespace
object is null
, then a prefix will be generated.OMElement.declareNamespace(String, String)
,
OMElement.findNamespace(String, String)
,
OMElement.getAllDeclaredNamespaces()
public void undeclarePrefix(String prefix)
OMElement
A namespace declaration with empty namespace name will be added even if no existing namespace declaration for the given prefix is in scope in the context of the current element. If a namespace declaration for the given prefix is already defined on this element, it will be replaced.
The namespace declaration created by this method will be returned by
OMElement.getAllDeclaredNamespaces()
. It is represented as an OMNamespace
object for
which OMNamespace.getNamespaceURI()
returns an empty string.
undeclarePrefix
in interface OMElement
prefix
- the prefix to undeclarepublic OMNamespace findNamespace(String uri, String prefix)
findNamespace
in interface OMElement
uri
- The namespace to look for. If this is specified, prefix should be
null.prefix
- The prefix to look for. If this is specified, uri should be null.OMElement.declareNamespace(String, String)
,
OMElement.declareNamespace(OMNamespace)
,
OMElement.getAllDeclaredNamespaces()
public OMNamespace findNamespaceURI(String prefix)
OMElement
findNamespaceURI
in interface OMElement
public Iterator getAllDeclaredNamespaces()
getAllDeclaredNamespaces
in interface OMElement
public Iterator getNamespacesInScope()
OMElement
OMNamespace
object with that prefix, and this object specifies
the namespace URI bound to the prefix. The iterator returns an OMNamespace
object
with an empty prefix if and only if there is a default namespace. It will never return an
OMNamespace
object with both the prefix and the namespace URI set to the empty
string, even if the element or one of its ancestors has a namespace declaration of the form
xmlns="".
The order in which the iterator returns the namespaces is undefined, and invoking the
Iterator.remove()
method on the returned iterator is not supported. The iterator may
be a "live" object, which means that results are undefined if the document is modified (in a
way that would modify the namespace context for the element) while the iterator is in use.
getNamespacesInScope
in interface OMElement
public NamespaceContext getNamespaceContext(boolean detached)
OMElement
The method supports two different NamespaceContext
implementation variants:
NamespaceContext
.
Typically, creating a live NamespaceContext
is cheaper, but the lookup performance of
a detached NamespaceContext
is better. The detached variant should always be used if
the reference to the NamespaceContext
is kept longer than the object model itself,
because in this case a live NamespaceContext
would prevent the object model from
being garbage collected.
getNamespaceContext
in interface OMElement
detached
- true
if the method should return a detached implementation,
false
if the method should return a live objectpublic Iterator getAllAttributes()
getAllAttributes
in interface OMElement
OMElement.getAttribute(javax.xml.namespace.QName)
,
OMElement.addAttribute(OMAttribute)
,
OMElement.addAttribute(String, String, OMNamespace)
public OMAttribute getAttribute(QName qname)
getAttribute
in interface OMElement
qname
- the qualified name to search forpublic String getAttributeValue(QName qname)
getAttributeValue
in interface OMElement
qname
- the qualified name to search forpublic OMAttribute addAttribute(OMAttribute attr)
The owner of the attribute is set to be the particular OMElement
.
If the attribute already has an owner then the attribute is cloned (i.e. its name,
value and namespace are copied to a new attribute) and the new attribute is added
to the element. It's owner is then set to be the particular OMElement
.
addAttribute
in interface OMElement
attr
- The attribute to add.OMAttributeImpl.equals(Object)
public void removeAttribute(OMAttribute attr)
OMElement
removeAttribute
in interface OMElement
attr
- the attribute to removepublic OMAttribute addAttribute(String attributeName, String value, OMNamespace ns)
OMElement
If the element already has an attribute with the same local name and namespace URI, then this
existing attribute will be removed from the element, i.e. this method will always create a
new OMAttribute
instance and never update an existing one.
addAttribute
in interface OMElement
attributeName
- The local name for the attribute.value
- The string value of the attribute. This function does not check to make sure that
the given attribute value can be serialized directly as an XML value. The caller
may, for example, pass a string with the character 0x01.ns
- The namespace has to be one of the in scope namespace. i.e. the passed namespace
must be declared in the parent element of this attribute or ancestors of the
parent element of the attribute.public void setBuilder(OMXMLParserWrapper wrapper)
setBuilder
in interface OMElement
public OMXMLParserWrapper getBuilder()
getBuilder
in interface IParentNode
getBuilder
in interface OMContainer
getBuilder
in class OMSerializableImpl
public OMNode getFirstOMChild()
getFirstOMChild
in interface OMContainer
public OMNode getFirstOMChildIfAvailable()
IParentNode
OMSerializable.isComplete()
may return false
when called on the child.
In contrast to OMContainer.getFirstOMChild()
, this method will never modify
the state of the underlying parser.getFirstOMChildIfAvailable
in interface IParentNode
null
if the container has no children or
the builder has not yet started to build the first childpublic OMNode getLastKnownOMChild()
getLastKnownOMChild
in interface IContainer
public void setFirstChild(OMNode firstChild)
setFirstChild
in interface IContainer
public void setLastChild(OMNode omNode)
IContainer
setLastChild
in interface IContainer
public OMNode detach() throws OMException
detach
in interface OMNode
detach
in class OMNodeImpl
OMException
public int getType()
OMNode
getType
in interface OMNode
OMNode.ELEMENT_NODE
, OMNode.TEXT_NODE
, OMNode.CDATA_SECTION_NODE
,
OMNode.COMMENT_NODE
, OMNode.DTD_NODE
, OMNode.PI_NODE
, OMNode.ENTITY_REFERENCE_NODE
or OMNode.SPACE_NODE
.public void build() throws OMException
OMSerializable
build
in interface OMSerializable
OMException
public int getState()
getState
in interface IParentNode
public boolean isComplete()
OMSerializable
isComplete
in interface IParentNode
isComplete
in interface OMSerializable
public void setComplete(boolean complete)
setComplete
in interface OMContainerEx
setComplete
in interface OMNodeEx
setComplete
in class OMSerializableImpl
public void discarded()
discarded
in interface OMContainerEx
public XMLStreamReader getXMLStreamReader()
OMContainer
OMContainer.getXMLStreamReader(boolean)
with cache
set to
true
.getXMLStreamReader
in interface OMContainer
XMLStreamReader
representation of this elementpublic XMLStreamReader getXMLStreamReaderWithoutCaching()
OMContainer
OMContainer.getXMLStreamReader(boolean)
with cache
set to
false
.getXMLStreamReaderWithoutCaching
in interface OMContainer
XMLStreamReader
representation of this elementpublic XMLStreamReader getXMLStreamReader(boolean cache)
OMContainer
XMLStreamReader
instance that produces a sequence of StAX events for this element and
its content. The sequence of events is independent of the state of this element and the value
of the cache
parameter, but the side effects of calling this method and
consuming the reader are different:
State | cache |
Side effects |
---|---|---|
The element is fully built (or was created programmatically). | true |
No side effects. The reader will synthesize StAX events from the object model. |
false |
||
The element is partially built, i.e. deferred parsing is taking place. | true |
When a StAX event is requested from the reader, it will built the information item (if necessary) and synthesize the StAX event. If the caller completely consumes the reader, the element will be completely built. Otherwise it will be partially built. |
false |
The reader will delegate to the underlying parser starting from the event corresponding to the last information item that has been built. In other words, after synthesizing a number of events, the reader will switch to delegation mode. An attempt to access the object model afterwards will result in an error. |
To free any resources associated with the returned reader, the caller MUST invoke the
XMLStreamReader.close()
method.
The returned reader MAY implement the extension defined by
DataHandlerReader
and any binary content will
be reported using this extension. More precisely, if the object model contains an
OMText
instance with OMText.isBinary()
returning true
(or
would contain such an instance after it has been fully built), then its data will always be
exposed through this extension.
The caller MUST NOT make any other assumption about the returned reader, in particular about its runtime type.
Note (non normative): For various reasons, existing code based on Axiom versions prior to 1.2.9 makes assumptions on the returned reader that should no longer be considered valid:
OMStAXWrapper
. While it is true that Axiom internally uses
this class to synthesize StAX events, it may wrap this instance in another reader
implementation. E.g. depending on the log level, the reader will be wrapped using
OMXMLStreamReaderValidator
. This was already the case in
Axiom versions prior to 1.2.9. It should also be noted that instances of
OMSourcedElement
(which extends the present interface) may return a reader that is
not implemented using OMStAXWrapper
.OMXMLStreamReader
interface of the returned reader to switch
off MTOM inlining using OMXMLStreamReader.setInlineMTOM(boolean)
. This has now been
deprecated and it is recommended to use
XOPEncodingStreamReader
instead.OMAttachmentAccessor
interface of the returned
reader to fetch attachments using OMAttachmentAccessor.getDataHandler(String)
. There
is no reason anymore to do so:OMXMLStreamReader.setInlineMTOM(boolean)
is used to disable MTOM inlining,
OMAttachmentAccessor.getDataHandler(String)
must be used to retrieve the binary
content. The fact that this method is deprecated removes the need for this.OMAttachmentAccessor.getDataHandler(String)
to retrieve the binary content. Starting
with 1.2.9 this is no longer be the case: as specified above, the sequence of events is
independent of the state of the object model and the value of the cache
parameter, and all binary content is reported through the
DataHandlerReader
extension.OMAttachmentAccessor.getDataHandler(String)
doesn't give access to the attachments in the SwA case (neither in 1.2.9 nor in previous
versions).
Code making any of these assumptions should be fixed, so that only XMLStreamReader
and DataHandlerReader
are used (and if
necessary, XOPEncodingStreamReader
).
getXMLStreamReader
in interface OMContainer
cache
- indicates if caching should be enabledXMLStreamReader
representation of this information itempublic XMLStreamReader getXMLStreamReader(boolean cache, OMXMLStreamReaderConfiguration configuration)
OMContainer
OMContainer.getXMLStreamReader(boolean)
, but accepts an OMXMLStreamReaderConfiguration
object that allows to specify additional options and to customize the behavior of the
returned reader.getXMLStreamReader
in interface OMContainer
cache
- indicates if caching should be enabledconfiguration
- additional configuration options; see the Javadoc of
OMXMLStreamReaderConfiguration
for more information about the available
optionsXMLStreamReader
representation of this information itempublic void setText(String text)
OMElement
OMText
after the method
returns. If the parameter is null
or an empty string, then the element will have
no children.public void setText(QName qname)
OMElement
QName
. If no matching namespace
declaration for the QName
is in scope, then this method will add one. If the
QName
specifies a namespace URI but no prefix, then a prefix will be generated. If
the element has children, then all these children are detached before the content is set. If
the parameter is not null
, then the element will have a single child of type
OMText
after the method returns. If the parameter is null
, then the
element will have no children.public String getText()
OMElement
This method iterates over all the text children of the element and concatenates them to a single string. Only direct children will be considered, i.e. the text is not extracted recursively. For example the return value for <element>A<child>B</child>C</element> will be AC.
All whitespace will be preserved.
public Reader getTextAsStream(boolean cache)
OMElement
new StringReader(element.getText())
The difference is that the stream implementation returned by this method is optimized for performance and is guaranteed to have constant memory usage, provided that:
OMElement
, i.e.
cache
is false
or the element is an OMSourcedElement
that
is backed by a non destructive OMDataSource
.
XMLStreamReader
in
the case of an OMSourcedElement
) is non coalescing. Note that this is not the default
in Axiom and it may be necessary to configure the parser with
StAXParserConfiguration.NON_COALESCING
.
getTextAsStream
in interface OMElement
cache
- whether to enable caching when accessing the elementOMElement.getText()
public QName getTextAsQName()
OMElement
QName
. The QName is interpreted in a way
that is compatible with the XML schema specification. In particular, surrounding whitespace
is ignored.getTextAsQName
in interface OMElement
null
if the element is empty or the QName could
not be resolvedpublic void writeTextTo(Writer out, boolean cache) throws IOException
OMElement
Writer
.
If cache
is true, this method has the same effect as the following instruction:
out.write(element.getText())
The difference is that this method is guaranteed to have constant memory usage and is
optimized for performance (with the same restrictions that apply to
OMElement.getTextAsStream(boolean)
).
The method does not call Writer.close()
.
writeTextTo
in interface OMElement
out
- the stream to write the content tocache
- whether to enable caching when accessing the elementIOException
- if an error occurs when writing to the streamOMElement.getText()
public void internalSerialize(XMLStreamWriter writer, boolean cache) throws XMLStreamException
OMSerializableImpl
internalSerialize
in interface OMNodeEx
internalSerialize
in class OMSerializableImpl
cache
- indicates if caching should be enabledXMLStreamException
public OMElement getFirstElement()
getFirstElement
in interface OMElement
public String getLocalName()
getLocalName
in interface OMNamedInformationItem
public void setLocalName(String localName)
setLocalName
in interface OMNamedInformationItem
localName
- the new local name of the information itempublic OMNamespace getNamespace()
OMNamedInformationItem
getNamespace
in interface OMNamedInformationItem
null
if the information item
has no namespace. Note that this implies that the method never returns an
OMNamespace
object with both prefix and namespace URI set to the empty
string. In addition, the prefix of the returned OMNamespace
object (if any)
is never null
: if a null
prefix was specified when creating
this information item, then a prefix has been automatically assigned and the assigned
prefix is returned.public String getPrefix()
OMNamedInformationItem
Node.getPrefix()
(when called on an Element
or Attr
).getPrefix
in interface OMNamedInformationItem
null
if the information item has
no prefixpublic String getNamespaceURI()
OMNamedInformationItem
Node.getNamespaceURI()
(when called on an
Element
or Attr
).getNamespaceURI
in interface OMNamedInformationItem
null
if the information
item has no namespacepublic void setNamespace(OMNamespace namespace)
OMElement
setNamespace
in interface OMElement
namespace
- The new namespace for this element, or null
to remove the namespace
from this element. If an OMNamespace
instance with a null
prefix is given, then a prefix will be generated automatically. In this case, the
generated prefix can be determined using OMNamedInformationItem.getNamespace()
.public void setNamespaceWithNoFindInCurrentScope(OMNamespace namespace)
OMElement
setNamespaceWithNoFindInCurrentScope
in interface OMElement
public QName getQName()
getQName
in interface OMNamedInformationItem
public String toStringWithConsume() throws XMLStreamException
OMElement
As for OMElement.toString()
, this method may cause high memory consumption for object model
trees containing optimized binary data and should therefore be used with care.
toStringWithConsume
in interface OMElement
XMLStreamException
public String toString()
OMElement
This method produces the same result as OMContainer.serialize(Writer)
. In particular,
the element is always serialized as plain XML and OMText
nodes containing optimized
binary data are always inlined using base64 encoding. Since the output is accumulated into a
single string object, this may result in high memory consumption. Therefore this method
should be used with care.
public void discard() throws OMException
discard
in interface OMNode
OMException
public QName resolveQName(String qname)
OMElement
QName
object. The implementation uses the algorithm defined by the XML
Schema specification. In particular, the namespace for an unprefixed QName is the default
namespace (not the null namespace), i.e. QNames are resolved in the same way as element
names.resolveQName
in interface OMElement
qname
- the QName literal to resolveQName
object, or null
if the QName can't be resolved, i.e.
if the prefix is not bound in the namespace context of this elementpublic OMElement cloneOMElement()
OMElement
OMInformationItem.clone(OMCloneOptions)
with default options.cloneOMElement
in interface OMElement
protected OMElement createClone(OMCloneOptions options, OMContainer targetParent)
public void setLineNumber(int lineNumber)
setLineNumber
in interface OMElement
public int getLineNumber()
getLineNumber
in interface OMElement
public void buildWithAttachments()
OMNodeImpl
buildWithAttachments
in interface OMNode
buildWithAttachments
in class OMNodeImpl
public SAXSource getSAXSource(boolean cache)
OMContainer
SAXSource
representation for this node. This method can be used to integrate
Axiom with APIs and third party libraries that don't support StAX. In particular it can be
used with the Transformer
API.
The returned object supports all events defined by ContentHandler
and
LexicalHandler
. DTDHandler
and DeclHandler
are not supported.
If the node is an element and has a parent which is not a document, care is taken to properly
generate ContentHandler.startPrefixMapping(String, String)
and
ContentHandler.endPrefixMapping(String)
events also for namespace mappings declared
on the ancestors of the element. To understand why this is important, consider the following
example:
<root xmlns:ns="urn:ns"><element attr="ns:someThing"/><root>
In that case, to correctly interpret the attribute value, the SAX content handler must be aware of the namespace mapping for the ns prefix, even if the serialization starts only at the child element.
getSAXSource
in interface OMContainer
cache
- Indicates if caching should be enabled. If set to false
, the returned
SAXSource
may only be used once, and using it may have the side effect of
consuming the original content of this node.SAXSource
representation of this elementpublic void removeChildren()
OMContainer
for (Iterator it = container.getChildren(); it.hasNext(); ) { it.next(); it.remove(); }However, the implementation may do this in an optimized way. In particular, if the node is incomplete, it may choose not to instantiate child node that would become unreachable anyway.
removeChildren
in interface OMContainer
Copyright © 2004–2019 The Apache Software Foundation. All rights reserved.