- All Implemented Interfaces:
Result
If no output DOM source is set, the transformation will create
a Document node as the holder for the result of the transformation,
which may be retrieved with getNode()
.
- Since:
- 1.4
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
IfTransformerFactory.getFeature(java.lang.String)
returnstrue
when passed this value as an argument, theTransformer
supportsResult
output of this type.Fields declared in interface javax.xml.transform.Result
PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING
-
Constructor Summary
ConstructorDescriptionZero-argument default constructor.Use a DOM node to create a new output target.Use a DOM node to create a new output target with the specified System ID.Use a DOM node to create a new output target specifying the child node where the result nodes should be inserted before.Use a DOM node to create a new output target specifying the child node where the result nodes should be inserted before and the specified System ID. -
Method Summary
Modifier and TypeMethodDescriptionGet the child node before which the result nodes will be inserted.getNode()
Get the node that will contain the result DOM tree.Get the System Identifier.void
setNextSibling
(Node nextSibling) Set the child node before which the result nodes will be inserted.void
Set the node that will contain the result DOM tree.void
setSystemId
(String systemId) Set the systemId that may be used in association with the node.
-
Field Details
-
FEATURE
IfTransformerFactory.getFeature(java.lang.String)
returnstrue
when passed this value as an argument, theTransformer
supportsResult
output of this type.- See Also:
-
-
Constructor Details
-
DOMResult
public DOMResult()Zero-argument default constructor.node
,siblingNode
andsystemId
will be set tonull
. -
DOMResult
Use a DOM node to create a new output target.In practice, the node should be a
Document
node, aDocumentFragment
node, or aElement
node. In other words, a node that accepts children.siblingNode
andsystemId
will be set tonull
.- Parameters:
node
- The DOM node that will contain the result tree.
-
DOMResult
Use a DOM node to create a new output target with the specified System ID.In practice, the node should be a
Document
node, aDocumentFragment
node, or aElement
node. In other words, a node that accepts children.siblingNode
will be set tonull
.- Parameters:
node
- The DOM node that will contain the result tree.systemId
- The system identifier which may be used in association with this node.
-
DOMResult
Use a DOM node to create a new output target specifying the child node where the result nodes should be inserted before.In practice,
node
andnextSibling
should be aDocument
node, aDocumentFragment
node, or aElement
node. In other words, a node that accepts children.Use
nextSibling
to specify the child node where the result nodes should be inserted before. IfnextSibling
is not a sibling ofnode
, then anIllegalArgumentException
is thrown. Ifnode
isnull
andnextSibling
is notnull
, then anIllegalArgumentException
is thrown. IfnextSibling
isnull
, then the behavior is the same as callingDOMResult(Node node)
, i.e. append the result nodes as the last child of the specifiednode
.systemId
will be set tonull
.- Parameters:
node
- The DOM node that will contain the result tree.nextSibling
- The child node where the result nodes should be inserted before.- Throws:
IllegalArgumentException
- IfnextSibling
is not a sibling ofnode
ornode
isnull
andnextSibling
is notnull
.- Since:
- 1.5
-
DOMResult
Use a DOM node to create a new output target specifying the child node where the result nodes should be inserted before and the specified System ID.In practice,
node
andnextSibling
should be aDocument
node, aDocumentFragment
node, or aElement
node. In other words, a node that accepts children.Use
nextSibling
to specify the child node where the result nodes should be inserted before. IfnextSibling
is not a sibling ofnode
, then anIllegalArgumentException
is thrown. Ifnode
isnull
andnextSibling
is notnull
, then anIllegalArgumentException
is thrown. IfnextSibling
isnull
, then the behavior is the same as callingDOMResult(Node node, String systemId)
, i.e. append the result nodes as the last child of the specified node and use the specified System ID.- Parameters:
node
- The DOM node that will contain the result tree.nextSibling
- The child node where the result nodes should be inserted before.systemId
- The system identifier which may be used in association with this node.- Throws:
IllegalArgumentException
- IfnextSibling
is not a sibling ofnode
ornode
isnull
andnextSibling
is notnull
.- Since:
- 1.5
-
-
Method Details
-
setNode
Set the node that will contain the result DOM tree.In practice, the node should be a
Document
node, aDocumentFragment
node, or aElement
node. In other words, a node that accepts children.An
IllegalStateException
is thrown ifnextSibling
is notnull
andnode
is not a parent ofnextSibling
. AnIllegalStateException
is thrown ifnode
isnull
andnextSibling
is notnull
.- Parameters:
node
- The node to which the transformation will be appended.- Throws:
IllegalStateException
- IfnextSibling
is notnull
andnextSibling
is not a child ofnode
ornode
isnull
andnextSibling
is notnull
.
-
getNode
Get the node that will contain the result DOM tree.If no node was set via
DOMResult(Node node)
,DOMResult(Node node, String systeId)
,DOMResult(Node node, Node nextSibling)
,DOMResult(Node node, Node nextSibling, String systemId)
orsetNode(Node node)
, then the node will be set by the transformation, and may be obtained from this method once the transformation is complete. Calling this method before the transformation will returnnull
.- Returns:
- The node to which the transformation will be appended.
-
setNextSibling
Set the child node before which the result nodes will be inserted.Use
nextSibling
to specify the child node before which the result nodes should be inserted. IfnextSibling
is not a descendant ofnode
, then anIllegalArgumentException
is thrown. Ifnode
isnull
andnextSibling
is notnull
, then anIllegalStateException
is thrown. IfnextSibling
isnull
, then the behavior is the same as callingDOMResult(Node node)
, i.e. append the result nodes as the last child of the specifiednode
.- Parameters:
nextSibling
- The child node before which the result nodes will be inserted.- Throws:
IllegalArgumentException
- IfnextSibling
is not a descendant ofnode
.IllegalStateException
- Ifnode
isnull
andnextSibling
is notnull
.- Since:
- 1.5
-
getNextSibling
Get the child node before which the result nodes will be inserted.If no node was set via
DOMResult(Node node, Node nextSibling)
,DOMResult(Node node, Node nextSibling, String systemId)
orsetNextSibling(Node nextSibling)
, thennull
will be returned.- Returns:
- The child node before which the result nodes will be inserted.
- Since:
- 1.5
-
setSystemId
Set the systemId that may be used in association with the node.- Specified by:
setSystemId
in interfaceResult
- Parameters:
systemId
- The system identifier as a URI string.
-
getSystemId
Get the System Identifier.If no System ID was set via
DOMResult(Node node, String systemId)
,DOMResult(Node node, Node nextSibling, String systemId)
orsetSystemId(String systemId)
, thennull
will be returned.- Specified by:
getSystemId
in interfaceResult
- Returns:
- The system identifier.
-