SAXResult

public class SAXResult
extends Object implements Result

java.lang.Object
   ↳ javax.xml.transform.sax.SAXResult


Acts as an holder for a transformation Result.

Summary

Constants

String FEATURE

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

Inherited constants

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 constructors

SAXResult()

Zero-argument default constructor.

SAXResult(ContentHandler handler)

Create a SAXResult that targets a SAX2 ContentHandler.

Public methods

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 methods

Object clone()

Creates and returns a copy of this object.

boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

void finalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

final Class<?> getClass()

Returns the runtime class of this Object.

int hashCode()

Returns a hash code value for the 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(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.

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()

Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

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

FEATURE

Added in API level 8
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

SAXResult

Added in API level 8
public SAXResult ()

Zero-argument default constructor.

SAXResult

Added in API level 8
public SAXResult (ContentHandler handler)

Create a SAXResult that targets a SAX2 ContentHandler.

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

Public methods

getHandler

Added in API level 8
public ContentHandler getHandler ()

Get the ContentHandler that is the Result.

Returns
ContentHandler The ContentHandler that is to be transformation output.

getLexicalHandler

Added in API level 8
public LexicalHandler getLexicalHandler ()

Get a SAX2 LexicalHandler for the output.

Returns
LexicalHandler A LexicalHandler, or null.

getSystemId

Added in API level 8
public String getSystemId ()

Get the system identifier that was set with setSystemId.

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

setHandler

Added in API level 8
public void setHandler (ContentHandler handler)

Set the target to be a SAX2 ContentHandler.

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

setLexicalHandler

Added in API level 8
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 LexicalHandler: A non-null LexicalHandler for handling lexical parse events.

setSystemId

Added in API level 8
public void setSystemId (String systemId)

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

Parameters
systemId String: The system identifier as a URI string.