com.phloc.commons.xml.serialize

Class SAXReader

java.lang.Object

com.phloc.commons.xml.serialize.SAXReader

@ThreadSafe
public final class SAXReader
extends Object

Helper class to read XML documents via SAX

Author:

Philip Helger

Method Summary

Methods

Modifier and Type	Method and Description
static ESuccess	readXMLSAX(byte[] aXML, int nOfs, int nLen, ISAXReaderSettings aSettings)
static ESuccess	readXMLSAX(byte[] aXML, ISAXReaderSettings aSettings)
static ESuccess	readXMLSAX(ByteBuffer aXML, ISAXReaderSettings aSettings)
static ESuccess	readXMLSAX(char[] aXML, int nOfs, int nLen, ISAXReaderSettings aSettings)
static ESuccess	readXMLSAX(char[] aXML, ISAXReaderSettings aSettings)
static ESuccess	readXMLSAX(CharSequence aXML, ISAXReaderSettings aSettings)
static ESuccess	readXMLSAX(File aFile, ISAXReaderSettings aSettings)
static ESuccess	readXMLSAX(IInputStreamProvider aISP, ISAXReaderSettings aSettings)
static ESuccess	readXMLSAX(InputSource aIS, ISAXReaderSettings aSettings) Read an XML document via a SAX handler.
static ESuccess	readXMLSAX(InputStream aIS, ISAXReaderSettings aSettings)
static ESuccess	readXMLSAX(IReadableResource aResource, ISAXReaderSettings aSettings)
static ESuccess	readXMLSAX(Reader aReader, ISAXReaderSettings aSettings)
static ESuccess	readXMLSAX(String sXML, ISAXReaderSettings aSettings)
static ESuccess	readXMLSAX(URI aURI, ISAXReaderSettings aSettings)
static ESuccess	readXMLSAX(URL aURL, ISAXReaderSettings aSettings)

Methods inherited from class java.lang.Object

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

Method Detail

readXMLSAX

@Nonnull
public static ESuccess readXMLSAX(@Nonnull
                          File aFile,
                          @Nonnull
                          ISAXReaderSettings aSettings)

readXMLSAX

@Nonnull
public static ESuccess readXMLSAX(@Nonnull
                          URI aURI,
                          @Nonnull
                          ISAXReaderSettings aSettings)

readXMLSAX

@Nonnull
public static ESuccess readXMLSAX(@Nonnull
                          URL aURL,
                          @Nonnull
                          ISAXReaderSettings aSettings)

readXMLSAX

@Nonnull
public static ESuccess readXMLSAX(@Nonnull
                          IInputStreamProvider aISP,
                          @Nonnull
                          ISAXReaderSettings aSettings)

readXMLSAX

@Nonnull
public static ESuccess readXMLSAX(@Nonnull
                          IReadableResource aResource,
                          @Nonnull
                          ISAXReaderSettings aSettings)

readXMLSAX

@Nonnull
public static ESuccess readXMLSAX(@Nonnull
                          CharSequence aXML,
                          @Nonnull
                          ISAXReaderSettings aSettings)

readXMLSAX

@Nonnull
public static ESuccess readXMLSAX(@Nonnull
                          String sXML,
                          @Nonnull
                          ISAXReaderSettings aSettings)

readXMLSAX

@Nonnull
public static ESuccess readXMLSAX(@Nonnull
                          char[] aXML,
                          @Nonnull
                          ISAXReaderSettings aSettings)

readXMLSAX

@Nonnull
public static ESuccess readXMLSAX(@Nonnull
                          char[] aXML,
                          @Nonnegative
                          int nOfs,
                          @Nonnegative
                          int nLen,
                          @Nonnull
                          ISAXReaderSettings aSettings)

readXMLSAX

@Nonnull
public static ESuccess readXMLSAX(@Nonnull
                          byte[] aXML,
                          @Nonnull
                          ISAXReaderSettings aSettings)

readXMLSAX

@Nonnull
public static ESuccess readXMLSAX(@Nonnull
                          byte[] aXML,
                          @Nonnegative
                          int nOfs,
                          @Nonnegative
                          int nLen,
                          @Nonnull
                          ISAXReaderSettings aSettings)

readXMLSAX

@Nonnull
public static ESuccess readXMLSAX(@Nonnull
                          ByteBuffer aXML,
                          @Nonnull
                          ISAXReaderSettings aSettings)

readXMLSAX

@Nonnull
public static ESuccess readXMLSAX(@Nonnull@WillClose
                          InputStream aIS,
                          @Nonnull
                          ISAXReaderSettings aSettings)

readXMLSAX

@Nonnull
public static ESuccess readXMLSAX(@Nonnull@WillClose
                          Reader aReader,
                          @Nonnull
                          ISAXReaderSettings aSettings)

readXMLSAX

@Nonnull
public static ESuccess readXMLSAX(@WillClose@Nonnull
                          InputSource aIS,
                          @Nonnull
                          ISAXReaderSettings aSettings)

Read an XML document via a SAX handler. The streams are closed after reading.

Parameters:

aIS - The input source to read from. Automatically closed upon success or error. May not be null. InputSourceFactory may be used to create InputSource objects from different input types.

aSettings - Reader settings. At least a content handler should be set. May be null.

Returns:

ESuccess.SUCCESS if reading succeeded, ESuccess.FAILURE otherwise