Class SAXResult

java.lang.Object

javax.xml.transform.sax.SAXResult

All Implemented Interfaces:: Result

public class SAXResult extends Object implements Result

Acts as an holder for a transformation Result.

Since:: 1.4

Field Summary

Modifier and Type	Field	Description
`static final String`	`FEATURE`	If `TransformerFactory.getFeature(String)` returns true when passed this value as an argument, the Transformer supports Result output of this type.

Fields declared in interface Result

PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING

Modifier and Type	Field	Description
`static final String`	`PI_DISABLE_OUTPUT_ESCAPING`	The name of the processing instruction that is sent if the result tree disables output escaping.
`static final String`	`PI_ENABLE_OUTPUT_ESCAPING`	The name of the processing instruction that is sent if the result tree enables output escaping at some point after having received a PI_DISABLE_OUTPUT_ESCAPING processing instruction.

Constructor Summary

Constructor	Description
`SAXResult()`	Zero-argument default constructor.
`SAXResult(ContentHandler handler)`	Create a SAXResult that targets a SAX2 `ContentHandler`.

Method Summary

Modifier and Type	Method	Description
`ContentHandler`	`getHandler()`	Get the `ContentHandler` that is the Result.
`LexicalHandler`	`getLexicalHandler()`	Get a SAX2 `LexicalHandler` for the output.
`String`	`getSystemId()`	Get the system identifier that was set with setSystemId.
`void`	`setHandler(ContentHandler handler)`	Set the target to be a SAX2 `ContentHandler`.
`void`	`setLexicalHandler(LexicalHandler handler)`	Set the SAX2 `LexicalHandler` for the output.
`void`	`setSystemId(String systemId)`	Method setSystemId Set the systemID that may be used in association with the `ContentHandler`.

Methods declared in class Object

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

Modifier and Type	Method	Description
`protected Object`	`clone()`	Creates and returns a copy of this object.
`boolean`	`equals(Object obj)`	Indicates whether some other object is "equal to" this one.
`protected void`	`finalize()`	Deprecated, for removal: This API element is subject to removal in a future version. Finalization is deprecated and subject to removal in a future release.
`final Class<?>`	`getClass()`	Returns the runtime class of this `Object`.
`int`	`hashCode()`	Returns a hash code value for this object.
`final void`	`notify()`	Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()`	Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()`	Returns a string representation of the object.
`final void`	`wait()`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
`final void`	`wait(long timeoutMillis)`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis, int nanos)`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

Field Details

FEATURE

public static final String FEATURE

If TransformerFactory.getFeature(String) returns true when passed this value as an argument, the Transformer supports Result output of this type.

See Also:

Constructor Details

SAXResult

public SAXResult()

Zero-argument default constructor.

SAXResult

public SAXResult(ContentHandler handler)

Create a SAXResult that targets a SAX2 ContentHandler.

Parameters:: handler - Must be a non-null ContentHandler reference.

Method Details

setHandler

public void setHandler(ContentHandler handler)

Set the target to be a SAX2 ContentHandler.

Parameters:: handler - Must be a non-null ContentHandler reference.

getHandler

public ContentHandler getHandler()

Get the ContentHandler that is the Result.

Returns:: The ContentHandler that is to be transformation output.

setLexicalHandler

public void setLexicalHandler(LexicalHandler handler)

Set the SAX2 LexicalHandler for the output.

This is needed to handle XML comments and the like. If the lexical handler is not set, an attempt should be made by the transformer to cast the ContentHandler to a LexicalHandler.

Parameters:: handler - A non-null LexicalHandler for handling lexical parse events.

getLexicalHandler

public LexicalHandler getLexicalHandler()

Get a SAX2 LexicalHandler for the output.

Returns:: A LexicalHandler, or null.

setSystemId

public void setSystemId(String systemId)

Method setSystemId Set the systemID that may be used in association with the ContentHandler.

Specified by:: setSystemId in interface Result
Parameters:: systemId - The system identifier as a URI string.

getSystemId

public String getSystemId()

Get the system identifier that was set with setSystemId.

Specified by:: getSystemId in interface Result
Returns:: The system identifier that was set with setSystemId, or null if setSystemId was not called.

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.