Top Description Methods
com.amazon.ion.impl.bin

public Interface _Private_IonRawWriter

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

Deprecated

This is a private API subject to change without notice.

An IonWriter with no symbol table management.

Method Summary

Modifier and TypeMethod and Description
public void
addTypeAnnotationSymbol(int
- a symbol ID
sid
)

Adds the given symbol ID to the list of pending annotation symbol IDs.

public void
setFieldNameSymbol(int
- a symbol ID
sid
)

Sets the current field name to the given symbol ID. It is up to the caller to make sure the given symbol ID has a mapping in the current context's symbol table.

public void
setTypeAnnotationSymbols(int...
- symbol IDs representing the annotation symbols for the current value
sids
)

Sets the full list of pending annotations to the given symbol IDs.

public void
writeString(byte[]
well-formed UTF-8-encoded bytes to be written. May be null to represent null.string.
data
,
int
offset of the first byte in value to write
offset
,
int
number of bytes to write from value
length
)

Writes a portion of the byte array out as an IonString value.

public void
writeSymbolToken(int
- a symbol ID
sid
)

Directly write the given symbol ID to represent a symbol value.

Inherited from com.amazon.ion.IonWriter:
addTypeAnnotationclosefinishflushgetSymbolTableisInStructsetFieldNamesetFieldNameSymbolsetTypeAnnotationssetTypeAnnotationSymbolsstepInstepOutwriteBlobwriteBlobwriteBoolwriteClobwriteClobwriteDecimalwriteFloatwriteIntwriteIntwriteNullwriteNullwriteStringwriteSymbolwriteSymbolTokenwriteTimestampwriteTimestampUTCwriteValuewriteValuewriteValues

Method Detail

addTypeAnnotationSymbolback to summary
public void addTypeAnnotationSymbol(int sid)

Adds the given symbol ID to the list of pending annotation symbol IDs. It is up to the caller to make sure the given symbol ID has a mapping in the current context's symbol table. The list of pending annotation symbol IDs is cleared when the current value is written via stepIn() or one of the write*() methods.

Parameters
sid:int

- a symbol ID

setFieldNameSymbolback to summary
public void setFieldNameSymbol(int sid)

Sets the current field name to the given symbol ID. It is up to the caller to make sure the given symbol ID has a mapping in the current context's symbol table. The pending field name symbol is cleared when the current value is written via stepIn() or one of the write*() methods.

Parameters
sid:int

- a symbol ID

setTypeAnnotationSymbolsback to summary
public void setTypeAnnotationSymbols(int... sids)

Sets the full list of pending annotations to the given symbol IDs. Any pending annotation symbol IDs are cleared. It is up to the caller to make sure the given symbol IDs have mappings in the current context's symbol table. The contents of the given array are copied into this writer, so the caller does not need to preserve the array. The list of pending annotation symbol IDs is cleared when the current value is written via stepIn() or one of the write*() methods.

Parameters
sids:int[]

- symbol IDs representing the annotation symbols for the current value

writeStringback to summary
public void writeString(byte[] data, int offset, int length) throws IOException

Writes a portion of the byte array out as an IonString value. This copies the portion of the byte array that is written.

Parameters
data:byte[]

well-formed UTF-8-encoded bytes to be written. May be null to represent null.string.

offset:int

offset of the first byte in value to write

length:int

number of bytes to write from value

See Also
IonWriter#writeClob(byte[], int, int), IonWriter#writeBlob(byte[], int, int)
writeSymbolTokenback to summary
public void writeSymbolToken(int sid) throws IOException

Directly write the given symbol ID to represent a symbol value. It is up to the caller to make sure the given symbol ID has a mapping in the current context's symbol table.

Parameters
sid:int

- a symbol ID