Ion Java 1.11.10 · com.amazon.ion.impl.lite.IonLoaderLite

Modifier and Type	Field and Description
private final IonCatalog	_catalog Not null.
private final IonReaderBuilder	_readerBuilder
private final IonSystemLite	_system

Access	Constructor and Description
public	IonLoaderLite(IonSystemLite must not be null. system, IonCatalog must not be null. catalog)

Method Summary

Modifier and Type	Method and Description
public IonCatalog	getCatalog() Implements com.amazon.ion.IonLoader.getCatalog. Gets the `IonCatalog` being used by this loader.
public IonSystem	getSystem() Implements com.amazon.ion.IonLoader.getSystem. Gets the `IonSystem` from which this loader was created.
public IonDatagram	load(File a file containing Ion data. ionFile) Implements com.amazon.ion.IonLoader.load. Loads an entire file of Ion data into a single datagram, detecting whether it's text or binary data.
public IonDatagram	load(String must not be null. ionText) Implements com.amazon.ion.IonLoader.load. Loads Ion text in its entirety.
public IonDatagram	load(Reader the reader from which to read Ion text. ionText) Implements com.amazon.ion.IonLoader.load. Loads a stream of Ion text into a single datagram.
public IonDatagram	load(byte[] may be either Ion binary data, or UTF-8 Ion text. This method assumes ownership of the array and may modify it at will. ionData) Implements com.amazon.ion.IonLoader.load. Loads a block of Ion data into a single datagram, detecting whether it's text or binary data.
public IonDatagram	load(InputStream the stream from which to read Ion data. ionData) Implements com.amazon.ion.IonLoader.load. Warning Will cause a memory leak when reading a gzipped stream, use `IonLoader#load(IonReader)` instead.
public IonDatagram	load(IonReader @param reader source of the Ion data to load. reader) Implements com.amazon.ion.IonLoader.load. Loads an entire stream of Ion data into a single datagram, detecting whether it's text or binary data.
private IonDatagramLite	Returns: a new datagram; not null. load_helper(IonReader reader) This doesn't wrap IOException because some callers need to propagate it.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

_catalog	back to summary
private final IonCatalog _catalog Not null.

_readerBuilder	back to summary
private final IonReaderBuilder _readerBuilder

_system	back to summary
private final IonSystemLite _system

IonLoaderLite	back to summary
public IonLoaderLite(IonSystemLite system, IonCatalog catalog) Parameters system:IonSystemLite must not be null. catalog:IonCatalog must not be null.

Method Detail

getCatalog back to summary

getCatalog	back to summary
public IonCatalog getCatalog() Implements com.amazon.ion.IonLoader.getCatalog. Doc from com.amazon.ion.IonLoader.getCatalog. Gets the `IonCatalog` being used by this loader. Returns:IonCatalog a catalog; not null.

public IonCatalog getCatalog()

Implements com.amazon.ion.IonLoader.getCatalog.

Doc from com.amazon.ion.IonLoader.getCatalog.

Gets the IonCatalog being used by this loader.

Returns:IonCatalog: a catalog; not null.

getSystem back to summary

getSystem	back to summary
public IonSystem getSystem() Implements com.amazon.ion.IonLoader.getSystem. Doc from com.amazon.ion.IonLoader.getSystem. Gets the `IonSystem` from which this loader was created. Returns:IonSystem the system instance; not `null`.

public IonSystem getSystem()

Implements com.amazon.ion.IonLoader.getSystem.

Doc from com.amazon.ion.IonLoader.getSystem.

Gets the IonSystem from which this loader was created.

Returns:IonSystem: the system instance; not null.

load back to summary

load	back to summary
public IonDatagram load(File ionFile) throws IonException, IOException Implements com.amazon.ion.IonLoader.load. Doc from com.amazon.ion.IonLoader.load. Loads an entire file of Ion data into a single datagram, detecting whether it's text or binary data. Parameters ionFile:File a file containing Ion data. Returns:IonDatagram a datagram containing all the values in the file; not null. Exceptions IonException: if there's a syntax error in the Ion content. IOException: if reading from the specified file results in an `IOException`.

public IonDatagram load(File ionFile) throws IonException, IOException

Implements com.amazon.ion.IonLoader.load.

Doc from com.amazon.ion.IonLoader.load.

Loads an entire file of Ion data into a single datagram, detecting whether it's text or binary data.

Parameters

ionFile:File: a file containing Ion data.

Returns:IonDatagram

a datagram containing all the values in the file; not null.

Exceptions

IonException:: if there's a syntax error in the Ion content.
IOException:: if reading from the specified file results in an IOException.

load	back to summary
public IonDatagram load(String ionText) throws IonException Implements com.amazon.ion.IonLoader.load. Doc from com.amazon.ion.IonLoader.load. Loads Ion text in its entirety. Parameters ionText:String must not be null. Returns:IonDatagram a datagram containing the input values; not null. Exceptions IonException: if there's a syntax error in the Ion content.

load

back to summary

public IonDatagram load(String ionText) throws IonException

Implements com.amazon.ion.IonLoader.load.

Doc from com.amazon.ion.IonLoader.load.

Loads Ion text in its entirety.

Parameters

ionText:String: must not be null.

Returns:IonDatagram

a datagram containing the input values; not null.

Exceptions

IonException:: if there's a syntax error in the Ion content.

load back to summary

load	back to summary
public IonDatagram load(Reader ionText) throws IonException, IOException Implements com.amazon.ion.IonLoader.load. Doc from com.amazon.ion.IonLoader.load. Loads a stream of Ion text into a single datagram. The specified reader remains open after this method returns. Because this library performs its own buffering, it's recommended that you avoid adding additional buffering to the given stream. Parameters ionText:Reader the reader from which to read Ion text. Returns:IonDatagram a datagram containing all the elements on the input stream; not null. Exceptions IonException: if there's a syntax error in the Ion content. IOException: if reading from the specified input stream results in an `IOException`.

public IonDatagram load(Reader ionText) throws IonException, IOException

Implements com.amazon.ion.IonLoader.load.

Doc from com.amazon.ion.IonLoader.load.

Loads a stream of Ion text into a single datagram.

The specified reader remains open after this method returns.

Because this library performs its own buffering, it's recommended that you avoid adding additional buffering to the given stream.

Parameters

ionText:Reader: the reader from which to read Ion text.

Returns:IonDatagram

a datagram containing all the elements on the input stream; not null.

Exceptions

IonException:: if there's a syntax error in the Ion content.
IOException:: if reading from the specified input stream results in an IOException.

load	back to summary
public IonDatagram load(byte[] ionData) throws IonException Implements com.amazon.ion.IonLoader.load. Doc from com.amazon.ion.IonLoader.load. Loads a block of Ion data into a single datagram, detecting whether it's text or binary data. This method will auto-detect and uncompress GZIPped Ion data. Parameters ionData:byte[] may be either Ion binary data, or UTF-8 Ion text. This method assumes ownership of the array and may modify it at will. Returns:IonDatagram a datagram containing all the values on the input stream; not null. Exceptions IonException: if there's a syntax error in the Ion content.

load

back to summary

public IonDatagram load(byte[] ionData) throws IonException

Implements com.amazon.ion.IonLoader.load.

Doc from com.amazon.ion.IonLoader.load.

Loads a block of Ion data into a single datagram, detecting whether it's text or binary data.

This method will auto-detect and uncompress GZIPped Ion data.

Parameters

ionData:byte[]: may be either Ion binary data, or UTF-8 Ion text. This method assumes ownership of the array and may modify it at will.

Returns:IonDatagram

a datagram containing all the values on the input stream; not null.

Exceptions

IonException:: if there's a syntax error in the Ion content.

load back to summary

load	back to summary
public IonDatagram load(InputStream ionData) throws IonException, IOException Implements com.amazon.ion.IonLoader.load. Doc from com.amazon.ion.IonLoader.load. Warning Will cause a memory leak when reading a gzipped stream, use `IonLoader#load(IonReader)` instead. Loads an entire stream of Ion data into a single datagram, detecting whether it's text or binary data. The specified stream remains open after this method returns. This method will auto-detect and uncompress GZIPped Ion data. Because this library performs its own buffering, it's recommended that you avoid adding additional buffering to the given stream. Parameters ionData:InputStream the stream from which to read Ion data. Returns:IonDatagram a datagram containing all the values on the input stream; not null. Exceptions IonException: if there's a syntax error in the Ion content. IOException: if reading from the specified input stream results in an `IOException`.

public IonDatagram load(InputStream ionData) throws IonException, IOException

Implements com.amazon.ion.IonLoader.load.

Doc from com.amazon.ion.IonLoader.load.

Warning

Will cause a memory leak when reading a gzipped stream, use IonLoader#load(IonReader) instead.

Loads an entire stream of Ion data into a single datagram, detecting whether it's text or binary data.

The specified stream remains open after this method returns.

This method will auto-detect and uncompress GZIPped Ion data.

Because this library performs its own buffering, it's recommended that you avoid adding additional buffering to the given stream.

Parameters

ionData:InputStream: the stream from which to read Ion data.

Returns:IonDatagram

a datagram containing all the values on the input stream; not null.

Exceptions

IonException:: if there's a syntax error in the Ion content.
IOException:: if reading from the specified input stream results in an IOException.

load	back to summary
public IonDatagram load(IonReader reader) throws IonException Implements com.amazon.ion.IonLoader.load. Doc from com.amazon.ion.IonLoader.load. Loads an entire stream of Ion data into a single datagram, detecting whether it's text or binary data. The specified reader remains open after this method returns. Parameters reader:IonReader @param reader source of the Ion data to load. Returns:IonDatagram a datagram containing all the values on the reader; not null. Exceptions IonException: if there's a syntax error in the Ion content.

load

back to summary

public IonDatagram load(IonReader reader) throws IonException

Implements com.amazon.ion.IonLoader.load.

Doc from com.amazon.ion.IonLoader.load.

Loads an entire stream of Ion data into a single datagram, detecting whether it's text or binary data.

The specified reader remains open after this method returns.

Parameters

reader:IonReader: @param reader source of the Ion data to load.

Returns:IonDatagram

a datagram containing all the values on the reader; not null.

Exceptions

IonException:: if there's a syntax error in the Ion content.

load_helper	back to summary
private IonDatagramLite load_helper(IonReader reader) throws IOException This doesn't wrap IOException because some callers need to propagate it. Returns:IonDatagramLite a new datagram; not null.

load_helper

back to summary

private IonDatagramLite load_helper(IonReader reader) throws IOException

This doesn't wrap IOException because some callers need to propagate it.

Returns:IonDatagramLite: a new datagram; not null.

pack-priv final Class IonLoaderLite

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail