Package org.apache.sis.xml

Class InputFactory

java.lang.Object

org.apache.sis.util.Static

org.apache.sis.xml.InputFactory

final class InputFactory
extends Static

Provides access to XMLInputFactory methods as static methods working on a SIS-wide instance. This convenience is provided in a separated class in order to allow the JVM to instantiate the factory only when first needed, when initializing this class.

Since:

0.4

Version:

1.0

Field Summary

Fields

Modifier and Type	Field	Description
private static final XMLInputFactory	FACTORY	The SIS-wide factory.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	InputFactory()	Do not allow instantiation of this class.

Method Summary

Modifier and Type	Method	Description
static XMLEventReader	createXMLEventReader(InputStream in)	Creates a new reader for the given stream.
static XMLEventReader	createXMLEventReader(Reader in)	Creates a new reader for the given stream.
static XMLEventReader	createXMLEventReader(XMLStreamReader in)	Creates a new reader for the given source.
static XMLEventReader	createXMLEventReader(Source in)	Creates a new reader for the given source.
static XMLEventReader	createXMLEventReader(Node in)	Creates a new reader for the given source.
static XMLEventReader	createXMLEventReader(InputSource in)	Creates a new reader for the given source.

Methods inherited from class java.lang.Object

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

Field Details

FACTORY

private static final XMLInputFactory FACTORY

The SIS-wide factory. This factory can be specified by the user, for example using the javax.xml.stream.XMLInputFactory system property.

Note: XMLInputFactory has an newDefaultFactory() method which bypass user settings.

Constructor Details

InputFactory

private InputFactory()

Do not allow instantiation of this class.

Method Details

createXMLEventReader

public static XMLEventReader createXMLEventReader(InputStream in)
                                           throws XMLStreamException

Creates a new reader for the given stream. It is caller's responsibility to close the given input stream after usage (it will not be done by XMLEventReader.close()).

Parameters:

in - where to read from.

Returns:

the reader.

Throws:

XMLStreamException - if the reader cannot be created.

createXMLEventReader

public static XMLEventReader createXMLEventReader(Reader in)
                                           throws XMLStreamException

Creates a new reader for the given stream. It is caller's responsibility to close the given reader after usage (it will not be done by XMLEventReader.close()).

Parameters:

in - where to read from.

Returns:

the reader.

Throws:

XMLStreamException - if the reader cannot be created.

createXMLEventReader

public static XMLEventReader createXMLEventReader(InputSource in)
                                           throws XMLStreamException

Creates a new reader for the given source.

Parameters:

in - where to read from.

Returns:

the reader.

Throws:

XMLStreamException - if the reader cannot be created.

createXMLEventReader

public static XMLEventReader createXMLEventReader(Node in)
                                           throws XMLStreamException

Creates a new reader for the given source.

Parameters:

in - where to read from.

Returns:

the reader.

Throws:

XMLStreamException - if the reader cannot be created.

createXMLEventReader

public static XMLEventReader createXMLEventReader(Source in)
                                           throws XMLStreamException

Creates a new reader for the given source.

Parameters:

in - where to read from.

Returns:

the reader.

Throws:

XMLStreamException - if the reader cannot be created.

createXMLEventReader

public static XMLEventReader createXMLEventReader(XMLStreamReader in)
                                           throws XMLStreamException

Creates a new reader for the given source. It is caller's responsibility to close the given stream reader after usage (it will not be done by XMLEventReader.close()).

Parameters:

in - where to read from.

Returns:

the reader.

Throws:

XMLStreamException - if the reader cannot be created.