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

Fields

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

Constructors

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()	Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
boolean	equals(Object o)	Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
protected void	finalize()	Deprecated, for removal: This API element is subject to removal in a future version. May cause performance issues, deadlocks and hangs.
final Class<? extends Object>	getClass()	Answers the unique instance of java.lang.Class which represents the class of the receiver.
int	hashCode()	Answers an integer hash code for the receiver.
final void	notify()	Causes one thread which is waiting on the receiver to be made ready to run.
final void	notifyAll()	Causes all threads which are waiting on the receiver to be made ready to run.
String	toString()	Answers a string containing a concise, human-readable description of the receiver.
final void	wait()	Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
final void	wait(long time)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
final void	wait(long time, int frac)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

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:

• Constant Field Values

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.