Ion Java 1.11.10 · com.amazon.ion.IonLob · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public int	Returns: the lob's size in bytes. byteSize() Gets the size in bytes of this lob.
public IonLob	clone() Redeclares com.amazon.ion.IonValue.clone. Creates a copy of this value and all of its children.
public byte[]	Returns: a new byte array, or `null` if `this.isNullValue()`. getBytes() Gets all the data of this lob, or `null` if this is an Ion `null` value.
public InputStream	Returns: a new stream positioned at the start of the lob, or `null` if `this.isNullValue()`. newInputStream() Creates a new `InputStream` that returns the data as raw bytes.
public void	setBytes(byte[] the new data for the lob; may be `null` to make this an Ion `null` value. bytes) Sets the data of this lob, copying bytes from an array.
public void	setBytes(byte[] the new data for the lob; may be `null` to make this an Ion `null` value. bytes, int the offset within the array of the first byte to copy; must be non-negative and no larger than `bytes.length`. offset, int the number of bytes to be copied from the given array; must be non-negative and no larger than `bytes.length - offset`. length) Sets the data of this lob, copying bytes from part of an array.

Method Detail

byteSize	back to summary
public int byteSize() Gets the size in bytes of this lob. Returns:int the lob's size in bytes.

byteSize

back to summary

public int byteSize()

Gets the size in bytes of this lob.

Returns:int: the lob's size in bytes.

clone back to summary

clone	back to summary
public IonLob clone() throws UnknownSymbolException Redeclares com.amazon.ion.IonValue.clone. Doc from com.amazon.ion.IonValue.clone. Creates a copy of this value and all of its children. The cloned value may use the same shared symbol tables, but it will have an independent local symbol table if necessary. The cloned value will be modifiable regardless of whether this instance `isReadOnly()`. The cloned value will be created in the context of the same `ValueFactory` as this instance; if you want a copy using a different factory, then use `ValueFactory#clone(IonValue)` instead. Exceptions UnknownSymbolException: if any part of this value has unknown text but known Sid for its field name, annotation or symbol.

public IonLob clone() throws UnknownSymbolException

Redeclares com.amazon.ion.IonValue.clone.

Doc from com.amazon.ion.IonValue.clone.

Creates a copy of this value and all of its children. The cloned value may use the same shared symbol tables, but it will have an independent local symbol table if necessary. The cloned value will be modifiable regardless of whether this instance isReadOnly().

The cloned value will be created in the context of the same ValueFactory as this instance; if you want a copy using a different factory, then use ValueFactory#clone(IonValue) instead.

Exceptions

UnknownSymbolException:: if any part of this value has unknown text but known Sid for its field name, annotation or symbol.

getBytes back to summary

getBytes	back to summary
public byte[] getBytes() Gets all the data of this lob, or `null` if this is an Ion `null` value. Returns:byte[] a new byte array, or `null` if `this.isNullValue()`.

public byte[] getBytes()

Gets all the data of this lob, or null if this is an Ion null value.

Returns:byte[]: a new byte array, or null if this.isNullValue().

newInputStream back to summary

newInputStream	back to summary
public InputStream newInputStream() Creates a new `InputStream` that returns the data as raw bytes. Returns:InputStream a new stream positioned at the start of the lob, or `null` if `this.isNullValue()`.

public InputStream newInputStream()

Creates a new InputStream that returns the data as raw bytes.

Returns:InputStream: a new stream positioned at the start of the lob, or null if this.isNullValue().

setBytes back to summary

setBytes	back to summary
public void setBytes(byte[] bytes) Sets the data of this lob, copying bytes from an array. Parameters bytes:byte[] the new data for the lob; may be `null` to make this an Ion `null` value.

public void setBytes(byte[] bytes)

Sets the data of this lob, copying bytes from an array.

Parameters

bytes:byte[]: the new data for the lob; may be null to make this an Ion null value.

setBytes back to summary

setBytes	back to summary
public void setBytes(byte[] bytes, int offset, int length) Sets the data of this lob, copying bytes from part of an array. This method copies `length` bytes from the given array into this value, starting at the given offset in the array. Parameters bytes:byte[] the new data for the lob; may be `null` to make this an Ion `null` value. offset:int the offset within the array of the first byte to copy; must be non-negative and no larger than `bytes.length`. length:int the number of bytes to be copied from the given array; must be non-negative and no larger than `bytes.length - offset`. Exceptions IndexOutOfBoundsException: if the preconditions on the `offset` and `length` parameters are not met.

public void setBytes(byte[] bytes, int offset, int length)

Sets the data of this lob, copying bytes from part of an array.

This method copies length bytes from the given array into this value, starting at the given offset in the array.

Parameters

bytes:byte[]: the new data for the lob; may be null to make this an Ion null value.
offset:int: the offset within the array of the first byte to copy; must be non-negative and no larger than bytes.length.
length:int: the number of bytes to be copied from the given array; must be non-negative and no larger than bytes.length - offset.

Exceptions

IndexOutOfBoundsException:: if the preconditions on the offset and length parameters are not met.

public Interface IonLob

Field Summary

Method Summary

Method Detail