Package com.amazon.ion.impl

Interface _Private_IonWriter

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, Faceted, java.io.Flushable, IonWriter

All Known Implementing Classes:

_Private_IonBinaryWriterImpl

public interface _Private_IonWriter
extends IonWriter

NOT FOR APPLICATION USE!

Method Summary

Modifier and Type	Method	Description
IonCatalog	getCatalog()	Mostly for testing at this point, but could be useful public API.
int	getDepth()	Returns the current depth of containers the writer is at.
boolean	isFieldNameSet()	Returns true if the field name has been set either through setFieldName or setFieldId.
boolean	isStreamCopyOptimized()	Indicates whether the writer is stream copy optimized through IonWriter.writeValue(com.amazon.ion.IonReader).
void	writeIonVersionMarker()	Write an Ion version marker symbol to the output.

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 Detail

getCatalog

IonCatalog getCatalog()

Mostly for testing at this point, but could be useful public API.

isFieldNameSet

boolean isFieldNameSet()

Returns true if the field name has been set either through setFieldName or setFieldId. This is generally more efficient than calling getFieldName or getFieldId and checking the return type as it does not need to resolve the name through a symbol table. This returns false if the field name has not been set.

Returns:

true if a field name has been set false otherwise

getDepth

int getDepth()

Returns the current depth of containers the writer is at. This is 0 if the writer is at top-level.

Returns:

int depth of container nesting

writeIonVersionMarker

void writeIonVersionMarker()
                    throws java.io.IOException

Write an Ion version marker symbol to the output. This is the $ion_1_0 value currently (in later versions the number may change). In text output this appears as the text symbol. In binary this will be the symbol id if the writer is in a list, sexp or struct. If the writer is currently at the top level this will write the "magic cookie" value. Writing a version marker will reset the symbol table to be the system symbol table.

Throws:

java.io.IOException

isStreamCopyOptimized

boolean isStreamCopyOptimized()

Indicates whether the writer is stream copy optimized through IonWriter.writeValue(com.amazon.ion.IonReader).