W3cubDocs

Class SAXSource

java.lang.Object

javax.xml.transform.sax.SAXSource

All Implemented Interfaces:: Source

public class SAXSource extends Object implements Source

Acts as an holder for SAX-style Source.

Note that XSLT requires namespace support. Attempting to transform an input source that is not generated with a namespace-aware parser may result in errors. Parsers can be made namespace aware by calling the SAXParserFactory.setNamespaceAware(boolean awareness) method.

Since:: 1.4

Field Summary

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

Constructor Summary

Constructor	Description
`SAXSource()`	Zero-argument default constructor.
`SAXSource(InputSource inputSource)`	Create a `SAXSource`, using a SAX `InputSource`.
`SAXSource(XMLReader reader, InputSource inputSource)`	Create a `SAXSource`, using an `XMLReader` and a SAX InputSource.

Method Summary

Modifier and Type	Method	Description
`InputSource`	`getInputSource()`	Get the SAX InputSource to be used for the Source.
`String`	`getSystemId()`	Get the base ID (URI or system ID) from where URIs will be resolved.
`XMLReader`	`getXMLReader()`	Get the XMLReader to be used for the Source.
`boolean`	`isEmpty()`	Indicates whether the `SAXSource` object is empty.
`void`	`setInputSource(InputSource inputSource)`	Set the SAX InputSource to be used for the Source.
`void`	`setSystemId(String systemId)`	Set the system identifier for this Source.
`void`	`setXMLReader(XMLReader reader)`	Set the XMLReader to be used for the Source.
`static InputSource`	`sourceToInputSource(Source source)`	Attempt to obtain a SAX InputSource object from a Source object.

Methods declared in class java.lang.Object

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

Field Details

FEATURE

public static final String FEATURE

If TransformerFactory.getFeature(java.lang.String) returns true when passed this value as an argument, the Transformer supports Source input of this type.

See Also:

Constructor Details

SAXSource

public SAXSource()

Zero-argument default constructor. If this constructor is used, and no SAX source is set using setInputSource(InputSource inputSource) , then the Transformer will create an empty source InputSource using new InputSource().

See Also:

SAXSource

public SAXSource(XMLReader reader, InputSource inputSource)

Create a SAXSource, using an XMLReader and a SAX InputSource. The Transformer or SAXTransformerFactory will set itself to be the reader's ContentHandler, and then will call reader.parse(inputSource).

Parameters:: reader - An XMLReader to be used for the parse.; inputSource - A SAX input source reference that must be non-null and that will be passed to the reader parse method.

SAXSource

public SAXSource(InputSource inputSource)

Create a SAXSource, using a SAX InputSource. The Transformer or SAXTransformerFactory creates a reader (if setXMLReader is not used), sets itself as the reader's ContentHandler, and calls reader.parse(inputSource).

Parameters:: inputSource - An input source reference that must be non-null and that will be passed to the parse method of the reader.

Method Details

setXMLReader

public void setXMLReader(XMLReader reader)

Set the XMLReader to be used for the Source.

Parameters:: reader - A valid XMLReader or XMLFilter reference.

getXMLReader

public XMLReader getXMLReader()

Get the XMLReader to be used for the Source.

Returns:: A valid XMLReader or XMLFilter reference, or null.

setInputSource

public void setInputSource(InputSource inputSource)

Set the SAX InputSource to be used for the Source.

Parameters:: inputSource - A valid InputSource reference.

getInputSource

public InputSource getInputSource()

Get the SAX InputSource to be used for the Source.

Returns:: A valid InputSource reference, or null.

setSystemId

public void setSystemId(String systemId)

Set the system identifier for this Source. If an input source has already been set, it will set the system ID or that input source, otherwise it will create a new input source.

The system identifier is optional if there is a byte stream or a character stream, but it is still useful to provide one, since the application can use it to resolve relative URIs and can include it in error messages and warnings (the parser will attempt to open a connection to the URI only if no byte stream or character stream is specified).

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

getSystemId

public String getSystemId()

Get the base ID (URI or system ID) from where URIs will be resolved.

Specified by:: getSystemId in interface Source
Returns:: Base URL for the Source, or null.

sourceToInputSource

public static InputSource sourceToInputSource(Source source)

Attempt to obtain a SAX InputSource object from a Source object.

Parameters:: source - Must be a non-null Source reference.
Returns:: An InputSource, or null if Source can not be converted.

isEmpty

public boolean isEmpty()

Indicates whether the SAXSource object is empty. Empty is defined as follows:

if the system identifier and InputSource are null;
if the system identifier is null, and the InputSource is empty.

Specified by:: isEmpty in interface Source
Returns:: true if the SAXSource object is empty, false otherwise

© 1993, 2023, 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.
https://docs.oracle.com/en/java/javase/21/docs/api/java.xml/javax/xml/transform/sax/SAXSource.html