Top Description Methods
com.amazon.ion

public Interface IonBinaryWriter

extends IonWriter
Known Direct Implementers
com.amazon.ion.impl._Private_IonBinaryWriterImpl, com.amazon.ion.impl.bin.IonBinaryWriterAdapter
Annotations
@Deprecated
Imports
java.io.IOException, .OutputStream

Deprecated

Use IonSystem#newBinaryWriter(OutputStream, SymbolTable...) instead.

An IonWriter that encodes Ion binary data.

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

the size in bytes.
byteSize
()
Deprecated

Gets the size in bytes of this binary data.

public byte[]

Returns:

the byte array with the writers output
getBytes
()
Deprecated

Copies the current contents of this writer as a new byte array holding Ion binary-encoded data.

public int

Returns:

number of bytes written
getBytes
(byte[]
users byte array to write into
bytes
,
int
initial offset in the array to write into
offset
,
int
maximum number of bytes to write
maxlen
)
Deprecated

Copies the current contents of the writer to a given byte array array.

public int

Returns:

int length of bytes written
writeBytes
(OutputStream
OutputStream to write the bytes to
userstream
)
Deprecated

Writes the current contents of the writer to the output stream.

Inherited from com.amazon.ion.IonWriter:
addTypeAnnotationclosefinishflushgetSymbolTableisInStructsetFieldNamesetFieldNameSymbolsetTypeAnnotationssetTypeAnnotationSymbolsstepInstepOutwriteBlobwriteBlobwriteBoolwriteClobwriteClobwriteDecimalwriteFloatwriteIntwriteIntwriteNullwriteNullwriteStringwriteSymbolwriteSymbolTokenwriteTimestampwriteTimestampUTCwriteValuewriteValuewriteValues

Method Detail

byteSizeback to summary
public int byteSize()

Deprecated

Gets the size in bytes of this binary data. This is generally needed before calling getBytes() or getBytes(byte[], int, int).

Returns:int

the size in bytes.

Annotations
@Deprecated
getBytesback to summary
public byte[] getBytes() throws IOException

Deprecated

Copies the current contents of this writer as a new byte array holding Ion binary-encoded data. This allocates an array of the size needed to exactly hold the output and copies the entire value to it.

Returns:byte[]

the byte array with the writers output

Annotations
@Deprecated
getBytesback to summary
public int getBytes(byte[] bytes, int offset, int maxlen) throws IOException

Deprecated

Copies the current contents of the writer to a given byte array array. This starts writing to the array at offset and writes up to maxlen bytes. If this writer is not able to stop in the middle of its work this may overwrite the array and later throw and exception.

Parameters
bytes:byte[]

users byte array to write into

offset:int

initial offset in the array to write into

maxlen:int

maximum number of bytes to write

Returns:int

number of bytes written

Annotations
@Deprecated
writeBytesback to summary
public int writeBytes(OutputStream userstream) throws IOException

Deprecated

Writes the current contents of the writer to the output stream. This is only valid if the writer is not in the middle of writing a container.

Parameters
userstream:OutputStream

OutputStream to write the bytes to

Returns:int

int length of bytes written

Annotations
@Deprecated