MicroReader (phloc-commons 4.4.4 API)

java.lang.Object
- com.phloc.commons.microdom.serialize.MicroReader

```
@Immutable
public final class MicroReader
extends Object
```
Utility class to read an XML stream into an IMicroDocument.

Author:

Philip Helger

Method Summary

Methods
Modifier and Type	Method and Description
`static IMicroDocument`	`readMicroXML(byte[] aXML)`
`static IMicroDocument`	`readMicroXML(byte[] aXML, int nOfs, int nLen)`
`static IMicroDocument`	`readMicroXML(byte[] aXML, int nOfs, int nLen, ISAXReaderSettings aSettings)`
`static IMicroDocument`	`readMicroXML(byte[] aXML, ISAXReaderSettings aSettings)`
`static IMicroDocument`	`readMicroXML(ByteBuffer aXML)`
`static IMicroDocument`	`readMicroXML(ByteBuffer aXML, ISAXReaderSettings aSettings)`
`static IMicroDocument`	`readMicroXML(char[] aXML)`
`static IMicroDocument`	`readMicroXML(char[] aXML, int nOfs, int nLen)`
`static IMicroDocument`	`readMicroXML(char[] aXML, int nOfs, int nLen, ISAXReaderSettings aSettings)`
`static IMicroDocument`	`readMicroXML(char[] aXML, ISAXReaderSettings aSettings)`
`static IMicroDocument`	`readMicroXML(CharSequence sXML)`
`static IMicroDocument`	`readMicroXML(CharSequence sXML, ISAXReaderSettings aSettings)`
`static IMicroDocument`	`readMicroXML(File aFile)`
`static IMicroDocument`	`readMicroXML(File aFile, ISAXReaderSettings aSettings)`
`static IMicroDocument`	`readMicroXML(IInputStreamProvider aISP)`
`static IMicroDocument`	`readMicroXML(IInputStreamProvider aISP, ISAXReaderSettings aSettings)`
`static IMicroDocument`	`readMicroXML(InputSource aInputSource)`
`static IMicroDocument`	`readMicroXML(InputSource aInputSource, ISAXReaderSettings aSettings)` Read the passed input source as MicroXML.
`static IMicroDocument`	`readMicroXML(InputStream aIS)`
`static IMicroDocument`	`readMicroXML(InputStream aIS, ISAXReaderSettings aSettings)`
`static IMicroDocument`	`readMicroXML(IReadableResource aRes)`
`static IMicroDocument`	`readMicroXML(IReadableResource aRes, ISAXReaderSettings aSettings)`
`static IMicroDocument`	`readMicroXML(Reader aReader)`
`static IMicroDocument`	`readMicroXML(Reader aReader, ISAXReaderSettings aSettings)`
`static IMicroDocument`	`readMicroXML(String sXML)`
`static IMicroDocument`	`readMicroXML(String sXML, ISAXReaderSettings aSettings)`
`static IMicroDocument`	`readMicroXML(URI aXML)`
`static IMicroDocument`	`readMicroXML(URI aXML, ISAXReaderSettings aSettings)`
`static IMicroDocument`	`readMicroXML(URL aXML)`
`static IMicroDocument`	`readMicroXML(URL aXML, ISAXReaderSettings aSettings)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

readMicroXML

@Nullable
public static IMicroDocument readMicroXML(@WillClose@Nullable
                                   InputSource aInputSource)

readMicroXML

@Nullable
public static IMicroDocument readMicroXML(@WillClose@Nullable
                                   InputSource aInputSource,
                                   @Nullable
                                   ISAXReaderSettings aSettings)

Read the passed input source as MicroXML.

Parameters:: aInputSource - The input source to use. May be null in which case null is directly returned.; aSettings - The settings to use. If null the default settings will be used.
Returns:: null if either the input source is null or if the input was invalid XML.

readMicroXML

@Nullable
public static IMicroDocument readMicroXML(@WillClose@Nullable
                                   InputStream aIS)

readMicroXML

@Nullable
public static IMicroDocument readMicroXML(@WillClose@Nullable
                                   InputStream aIS,
                                   @Nullable
                                   ISAXReaderSettings aSettings)

readMicroXML

@Nullable
public static IMicroDocument readMicroXML(@Nullable
                                   File aFile)

readMicroXML

@Nullable
public static IMicroDocument readMicroXML(@Nullable
                                   File aFile,
                                   @Nullable
                                   ISAXReaderSettings aSettings)

readMicroXML

@Nullable
public static IMicroDocument readMicroXML(@Nullable
                                   IReadableResource aRes)

readMicroXML

@Nullable
public static IMicroDocument readMicroXML(@Nullable
                                   IReadableResource aRes,
                                   @Nullable
                                   ISAXReaderSettings aSettings)

readMicroXML

@Nullable
public static IMicroDocument readMicroXML(@Nullable
                                   IInputStreamProvider aISP)

readMicroXML

@Nullable
public static IMicroDocument readMicroXML(@Nullable
                                   IInputStreamProvider aISP,
                                   @Nullable
                                   ISAXReaderSettings aSettings)

readMicroXML

@Nullable
public static IMicroDocument readMicroXML(@WillClose@Nullable
                                   Reader aReader)

readMicroXML

@Nullable
public static IMicroDocument readMicroXML(@WillClose@Nullable
                                   Reader aReader,
                                   @Nullable
                                   ISAXReaderSettings aSettings)

readMicroXML

@Nullable
public static IMicroDocument readMicroXML(@Nullable
                                   String sXML)

readMicroXML

@Nullable
public static IMicroDocument readMicroXML(@Nullable
                                   String sXML,
                                   @Nullable
                                   ISAXReaderSettings aSettings)

readMicroXML

@Nullable
public static IMicroDocument readMicroXML(@Nullable
                                   CharSequence sXML)

readMicroXML

@Nullable
public static IMicroDocument readMicroXML(@Nullable
                                   CharSequence sXML,
                                   @Nullable
                                   ISAXReaderSettings aSettings)

readMicroXML

@Nullable
public static IMicroDocument readMicroXML(@Nullable
                                   byte[] aXML)

readMicroXML

@Nullable
public static IMicroDocument readMicroXML(@Nullable
                                   byte[] aXML,
                                   @Nullable
                                   ISAXReaderSettings aSettings)

readMicroXML

@Nullable
public static IMicroDocument readMicroXML(@Nullable
                                   byte[] aXML,
                                   @Nonnegative
                                   int nOfs,
                                   @Nonnegative
                                   int nLen)

readMicroXML

@Nullable
public static IMicroDocument readMicroXML(@Nullable
                                   byte[] aXML,
                                   @Nonnegative
                                   int nOfs,
                                   @Nonnegative
                                   int nLen,
                                   @Nullable
                                   ISAXReaderSettings aSettings)

readMicroXML

@Nullable
public static IMicroDocument readMicroXML(@Nullable
                                   char[] aXML)

readMicroXML

@Nullable
public static IMicroDocument readMicroXML(@Nullable
                                   char[] aXML,
                                   @Nullable
                                   ISAXReaderSettings aSettings)

readMicroXML

@Nullable
public static IMicroDocument readMicroXML(@Nullable
                                   char[] aXML,
                                   @Nonnegative
                                   int nOfs,
                                   @Nonnegative
                                   int nLen)

readMicroXML

@Nullable
public static IMicroDocument readMicroXML(@Nullable
                                   char[] aXML,
                                   @Nonnegative
                                   int nOfs,
                                   @Nonnegative
                                   int nLen,
                                   @Nullable
                                   ISAXReaderSettings aSettings)

readMicroXML

@Nullable
public static IMicroDocument readMicroXML(@Nullable
                                   ByteBuffer aXML)

readMicroXML

@Nullable
public static IMicroDocument readMicroXML(@Nullable
                                   ByteBuffer aXML,
                                   @Nullable
                                   ISAXReaderSettings aSettings)

readMicroXML

@Nullable
public static IMicroDocument readMicroXML(@Nullable
                                   URI aXML)

readMicroXML

@Nullable
public static IMicroDocument readMicroXML(@Nullable
                                   URI aXML,
                                   @Nullable
                                   ISAXReaderSettings aSettings)

readMicroXML

@Nullable
public static IMicroDocument readMicroXML(@Nullable
                                   URL aXML)

readMicroXML

@Nullable
public static IMicroDocument readMicroXML(@Nullable
                                   URL aXML,
                                   @Nullable
                                   ISAXReaderSettings aSettings)

Class MicroReader

Method Summary

Methods inherited from class java.lang.Object

Method Detail

readMicroXML

readMicroXML

readMicroXML

readMicroXML

readMicroXML

readMicroXML

readMicroXML

readMicroXML

readMicroXML

readMicroXML

readMicroXML

readMicroXML

readMicroXML

readMicroXML

readMicroXML

readMicroXML

readMicroXML

readMicroXML

readMicroXML

readMicroXML

readMicroXML

readMicroXML

readMicroXML

readMicroXML

readMicroXML

readMicroXML

readMicroXML

readMicroXML

readMicroXML

readMicroXML