Package com.amazon.ion

Interface IonBinaryWriter

All Superinterfaces:

AutoCloseable, Closeable, Faceted, Flushable, IonWriter

All Known Implementing Classes:

_Private_IonBinaryWriterImpl

@Deprecated
public interface IonBinaryWriter
extends IonWriter

Deprecated.

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

An IonWriter that encodes Ion binary data.

Method Summary

Modifier and Type	Method	Description
int	byteSize()	Deprecated.
byte[]	getBytes()	Deprecated.
int	getBytes(byte[] bytes, int offset, int maxlen)	Deprecated.
int	writeBytes(OutputStream userstream)	Deprecated.

Methods inherited from interface com.amazon.ion.facet.Faceted

asFacet

Methods inherited from interface com.amazon.ion.IonWriter

addTypeAnnotation, close, finish, flush, getSymbolTable, isInStruct, setFieldName, setFieldNameSymbol, setTypeAnnotations, setTypeAnnotationSymbols, stepIn, stepOut, writeBlob, writeBlob, writeBool, writeClob, writeClob, writeDecimal, writeFloat, writeInt, writeInt, writeNull, writeNull, writeString, writeSymbol, writeSymbolToken, writeTimestamp, writeTimestampUTC, writeValue, writeValue, writeValues

Method Details

byteSize

@Deprecated
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:

the size in bytes.

getBytes

@Deprecated
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:

the byte array with the writers output

Throws:

IOException

getBytes

@Deprecated
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 - users byte array to write into

offset - initial offset in the array to write into

maxlen - maximum number of bytes to write

Returns:

number of bytes written

Throws:

IOException

writeBytes

@Deprecated
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 to write the bytes to

Returns:

int length of bytes written

Throws:

IOException