SAXResult

AI-generated Key Takeaways

• SAXResult acts as a holder for transformation results, allowing you to target a SAX2 ContentHandler.

• It provides methods for setting and retrieving the ContentHandler, LexicalHandler, and system identifier.

• You can create a SAXResult using a zero-argument constructor or by specifying a ContentHandler directly.

• The FEATURE constant indicates if a Transformer supports SAXResult output.

• LexicalHandler can be set to handle XML comments and other lexical events during transformation.

public class SAXResult extends Object
implements Result

Acts as an holder for a transformation Result.

Constant Summary

String

FEATURE

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

Inherited Constant Summary

From interface javax.xml.transform.Result

String	PI_DISABLE_OUTPUT_ESCAPING	The name of the processing instruction that is sent if the result tree disables output escaping.
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.

Public Constructor Summary

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

Public Method Summary

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.

Inherited Method Summary

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

From interface javax.xml.transform.Result

abstract String	getSystemId() Get the system identifier that was set with setSystemId.
abstract void	setSystemId(String systemId) Set the system identifier for this Result.

Constants

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.

Constant Value: "http://javax.xml.transform.sax.SAXResult/feature"

Public Constructors

public SAXResult ()

Zero-argument default constructor.

public SAXResult (ContentHandler handler)

Create a SAXResult that targets a SAX2 ContentHandler.

Parameters

handler	Must be a non-null ContentHandler reference.

Public Methods

public ContentHandler getHandler ()

Get the ContentHandler that is the Result.

Returns

• The ContentHandler that is to be transformation output.

public LexicalHandler getLexicalHandler ()

Get a SAX2 LexicalHandler for the output.

Returns

• A LexicalHandler, or null.

public String getSystemId ()

Get the system identifier that was set with setSystemId.

Returns

• The system identifier that was set with setSystemId, or null if setSystemId was not called.

public void setHandler (ContentHandler handler)

Set the target to be a SAX2 ContentHandler.

Parameters

handler	Must be a non-null ContentHandler reference.

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.

public void setSystemId (String systemId)

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

Parameters

systemId	The system identifier as a URI string.