Ion Java 1.11.10 · com.amazon.ion.impl.IonWriterSystemText

Modifier and Type	Field and Description
private boolean	_closed Ensure we don't use a closed `output` stream.
private boolean	_following_long_string True when the last data written was a triple-quoted string, meaning we cannot write another long string lest it be incorrectly concatenated.
pack-priv boolean	_in_struct True when the current container is a struct, so we write field names.
private boolean	_is_writing_ivm Indicates whether we're currently writing an IVM.
private final int	_long_string_threshold At least one.
private final _Private_IonTextWriterBuilder	_options Not null.
private final _Private_IonTextAppender	_output
pack-priv boolean	_pending_separator
pack-priv CharSequence	_separator_character
pack-priv int[]	_stack_parent_type
pack-priv boolean[]	_stack_pending_comma
pack-priv int	_top

Access	Constructor and Description
protected	IonWriterSystemText(SymbolTable defaultSystemSymtab, _Private_IonTextWriterBuilder options, _Private_FastAppendable out)

Method Summary

Modifier and Type	Method and Description
public void	close() Implements com.amazon.ion.IonWriter.close. Closes this stream and releases any system resources associated with it.
pack-priv void	closeCollection(char closeChar)
pack-priv void	closeValue()
private boolean	containerIsSexp()
public void	flush() Implements com.amazon.ion.IonWriter.flush. Flushes this writer by writing any buffered output to the underlying output target without finalizing the stream's local symbol table.
pack-priv _Private_IonTextWriterBuilder	getBuilder()
protected IonType	getContainer()
public int	getDepth() Implements abstract com.amazon.ion.impl._Private_IonWriterBase.getDepth. Returns the current depth of containers the writer is at.
pack-priv void	growStack()
public boolean	isInStruct() Implements com.amazon.ion.IonWriter.isInStruct. Determines whether values are being written as fields of a struct.
pack-priv int	pop()
pack-priv void	printLeadingWhiteSpace()
pack-priv void	push(int typeid)
pack-priv void	startValue() Overrides com.amazon.ion.impl.IonWriterSystem.startValue.
public void	stepIn(IonType must be one of `IonType#LIST`, `IonType#SEXP`, or `IonType#STRUCT`. containerType) Implements com.amazon.ion.IonWriter.stepIn. Writes the beginning of a non-null container (list, sexp, or struct).
public void	stepOut() Implements com.amazon.ion.IonWriter.stepOut. Writes the end of the current container, returning this writer to the context of parent container.
pack-priv boolean	topPendingComma()
pack-priv int	Returns: a tid topType()
pack-priv void	writeAnnotations(SymbolToken[] annotations)
pack-priv void	writeAnnotationToken(SymbolToken ann)
public void	writeBlob(byte[] bytes to be written. May be `null` to represent `null.blob`. value, int offset of the first byte in value to write start, int number of bytes to write from value len) Implements com.amazon.ion.IonWriter.writeBlob. Writes a portion of the byte array out as an IonBlob value.
public void	writeBool(boolean true or false as desired value) Implements com.amazon.ion.IonWriter.writeBool. writes a non-null boolean value (true or false) as an IonBool to output.
public void	writeClob(byte[] bytes to be written. May be `null` to represent `null.clob`. value, int offset of the first byte in value to write start, int number of bytes to write from value len) Implements com.amazon.ion.IonWriter.writeClob. Writes a portion of the byte array out as an IonClob value.
public void	writeDecimal(BigDecimal may be null to represent `null.decimal`. value) Implements abstract com.amazon.ion.impl._Private_IonWriterBase.writeDecimal. Implements com.amazon.ion.IonWriter.writeDecimal. Writes a BigDecimal value as an Ion decimal.
pack-priv void	writeFieldNameToken(SymbolToken sym)
public void	writeFloat(double double to write value) Implements com.amazon.ion.IonWriter.writeFloat. writes a 64 bit binary floating point value, a Java double, as an IonFloat.
public void	writeInt(long signed int to write value) Implements com.amazon.ion.IonWriter.writeInt. writes a signed 64 bit value, a Java long, as an IonInt.
public void	writeInt(BigInteger BigInteger to write value) Implements com.amazon.ion.IonWriter.writeInt. writes a BigInteger value as an IonInt.
pack-priv void	writeIonVersionMarkerAsIs(SymbolTable systemSymtab) Implements abstract com.amazon.ion.impl.IonWriterSystem.writeIonVersionMarkerAsIs. Writes an IVM without checking preconditions or `InitialIVMHandling`.
pack-priv void	writeLocalSymtab(SymbolTable symtab) Overrides com.amazon.ion.impl.IonWriterSystem.writeLocalSymtab.
public void	writeNull() Overrides com.amazon.ion.impl._Private_IonWriterBase.writeNull. Implements com.amazon.ion.IonWriter.writeNull. Writes a value of Ion's null type (`null` aka `null.null`).
public void	writeNull(IonType type of the null to be written type) Implements com.amazon.ion.IonWriter.writeNull. Writes a null value of a specified Ion type.
pack-priv boolean	writeSeparator(boolean followingLongString)
private void	writeSidLiteral(int sid)
public void	writeString(String may be null to represent `null.string`. value) Implements com.amazon.ion.IonWriter.writeString. Writes a `java.lang.String` as an Ion string.
pack-priv void	writeSymbolAsIs(int symbolId) Implements abstract com.amazon.ion.impl.IonWriterSystem.writeSymbolAsIs. Writes a symbol without checking for system ID.
public void	writeSymbolAsIs(String value) Implements abstract com.amazon.ion.impl.IonWriterSystem.writeSymbolAsIs. Writes a symbol without checking for system ID.
private void	writeSymbolToken(String must not be null. value)
public void	writeTimestamp(Timestamp may be null to represent `null.timestamp`. value) Implements com.amazon.ion.IonWriter.writeTimestamp. Writes a timestamp value.

_closed	back to summary
private boolean _closed Ensure we don't use a closed `output` stream.

_following_long_string	back to summary
private boolean _following_long_string True when the last data written was a triple-quoted string, meaning we cannot write another long string lest it be incorrectly concatenated.

_in_struct	back to summary
pack-priv boolean _in_struct True when the current container is a struct, so we write field names.

_is_writing_ivm	back to summary
private boolean _is_writing_ivm Indicates whether we're currently writing an IVM.

_long_string_threshold	back to summary
private final int _long_string_threshold At least one.

_options	back to summary
private final _Private_IonTextWriterBuilder _options Not null.

_output	back to summary
private final _Private_IonTextAppender _output

_pending_separator	back to summary
pack-priv boolean _pending_separator

_separator_character	back to summary
pack-priv CharSequence _separator_character

_stack_parent_type	back to summary
pack-priv int[] _stack_parent_type

_stack_pending_comma	back to summary
pack-priv boolean[] _stack_pending_comma

_top	back to summary
pack-priv int _top

IonWriterSystemText	back to summary
protected IonWriterSystemText(SymbolTable defaultSystemSymtab, _Private_IonTextWriterBuilder options, _Private_FastAppendable out) Exceptions NullPointerException: if any parameter is null.

Method Detail

close back to summary

close	back to summary
public void close() throws IOException Implements com.amazon.ion.IonWriter.close. Doc from com.amazon.ion.IonWriter.close. Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect. If the cursor is between top-level values, this method will `finish()` before closing the underlying output stream. If not, the resulting data may be incomplete and invalid Ion. In other words: unless you're recovering from a failure condition, don't close the writer until you've stepped-out back to the starting level. Exceptions IOException: if thrown by the underlying output target.

public void close() throws IOException

Implements com.amazon.ion.IonWriter.close.

Doc from com.amazon.ion.IonWriter.close.

Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect.

If the cursor is between top-level values, this method will finish() before closing the underlying output stream. If not, the resulting data may be incomplete and invalid Ion.

In other words: unless you're recovering from a failure condition, don't close the writer until you've stepped-out back to the starting level.

Exceptions

IOException:: if thrown by the underlying output target.

closeCollection	back to summary
pack-priv void closeCollection(char closeChar) throws IOException

closeValue	back to summary
pack-priv void closeValue() throws IOException

containerIsSexp	back to summary
private boolean containerIsSexp()

flush back to summary

flush	back to summary
public void flush() throws IOException Implements com.amazon.ion.IonWriter.flush. Doc from com.amazon.ion.IonWriter.flush. Flushes this writer by writing any buffered output to the underlying output target without finalizing the stream's local symbol table. For some implementations this may have no effect even when some data is buffered, because it's not always possible to fully write partial data. In particular, when writing binary Ion data, Ion's length-prefixed encoding requires a complete top-level value to be written at once. If localSymbolTableAppend is enabled (see `com.amazon.ion.system.IonBinaryWriterBuilder#withLocalSymbolTableAppendEnabled`), this feature can be used to flush buffered data before writing more values without subsequently having to redeclare the current local symbol table. Applications that produce long streams of binary Ion may wish to flush occasionally to relieve memory pressure, then continue writing data using the same local symbol table. The symbol table will be appended with newly-encountered symbols as necessary. The `OutputStream` spec is mum regarding the behavior of flush on a closed stream, so we shouldn't assume that our stream can handle that. Exceptions IOException: if thrown by the underlying output target.

public void flush() throws IOException

Implements com.amazon.ion.IonWriter.flush.

Doc from com.amazon.ion.IonWriter.flush.

Flushes this writer by writing any buffered output to the underlying output target without finalizing the stream's local symbol table.

For some implementations this may have no effect even when some data is buffered, because it's not always possible to fully write partial data. In particular, when writing binary Ion data, Ion's length-prefixed encoding requires a complete top-level value to be written at once.

If localSymbolTableAppend is enabled (see com.amazon.ion.system.IonBinaryWriterBuilder#withLocalSymbolTableAppendEnabled), this feature can be used to flush buffered data before writing more values without subsequently having to redeclare the current local symbol table. Applications that produce long streams of binary Ion may wish to flush occasionally to relieve memory pressure, then continue writing data using the same local symbol table. The symbol table will be appended with newly-encountered symbols as necessary.

The OutputStream spec is mum regarding the behavior of flush on a closed stream, so we shouldn't assume that our stream can handle that.

Exceptions

IOException:: if thrown by the underlying output target.

getBuilder	back to summary
pack-priv _Private_IonTextWriterBuilder getBuilder()

getContainer	back to summary
protected IonType getContainer()

getDepth	back to summary
public int getDepth() Implements abstract com.amazon.ion.impl._Private_IonWriterBase.getDepth. Doc from com.amazon.ion.impl._Private_IonWriterBase.getDepth. Returns the current depth of containers the writer is at. This is 0 if the writer is at top-level. Returns:int int depth of container nesting Annotations @Override

getDepth

back to summary

public int getDepth()

Implements abstract com.amazon.ion.impl._Private_IonWriterBase.getDepth.

Doc from com.amazon.ion.impl._Private_IonWriterBase.getDepth.

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

Returns:int

int depth of container nesting

Annotations

@Override

growStack	back to summary
pack-priv void growStack()

isInStruct	back to summary
public boolean isInStruct() Implements com.amazon.ion.IonWriter.isInStruct. Doc from com.amazon.ion.IonWriter.isInStruct. Determines whether values are being written as fields of a struct. This is especially useful when it is not clear whether field names need to be written or not. Returns:boolean true when the parent is a struct.

isInStruct

back to summary

public boolean isInStruct()

Implements com.amazon.ion.IonWriter.isInStruct.

Doc from com.amazon.ion.IonWriter.isInStruct.

Determines whether values are being written as fields of a struct. This is especially useful when it is not clear whether field names need to be written or not.

Returns:boolean: true when the parent is a struct.

pop	back to summary
pack-priv int pop()

printLeadingWhiteSpace	back to summary
pack-priv void printLeadingWhiteSpace() throws IOException

push	back to summary
pack-priv void push(int typeid)

startValue	back to summary
pack-priv void startValue() throws IOException Overrides com.amazon.ion.impl.IonWriterSystem.startValue. Annotations @Override

startValue

back to summary

pack-priv void startValue() throws IOException

Overrides com.amazon.ion.impl.IonWriterSystem.startValue.

Annotations

@Override

stepIn back to summary

stepIn	back to summary
public void stepIn(IonType containerType) throws IOException Implements com.amazon.ion.IonWriter.stepIn. Doc from com.amazon.ion.IonWriter.stepIn. Writes the beginning of a non-null container (list, sexp, or struct). This must be matched by a call to `stepOut()` after the last child value. This method is not used to write `null.list` et al. To write null values use `writeNull(IonType)`. Parameters containerType:IonType must be one of `IonType#LIST`, `IonType#SEXP`, or `IonType#STRUCT`.

public void stepIn(IonType containerType) throws IOException

Implements com.amazon.ion.IonWriter.stepIn.

Doc from com.amazon.ion.IonWriter.stepIn.

Writes the beginning of a non-null container (list, sexp, or struct). This must be matched by a call to stepOut() after the last child value.

This method is not used to write null.list et al. To write null values use writeNull(IonType).

Parameters

containerType:IonType: must be one of IonType#LIST, IonType#SEXP, or IonType#STRUCT.

stepOut back to summary

stepOut	back to summary
public void stepOut() throws IOException Implements com.amazon.ion.IonWriter.stepOut. Doc from com.amazon.ion.IonWriter.stepOut. Writes the end of the current container, returning this writer to the context of parent container. Invocation of this method must match a preceding call to `stepIn(IonType)`.

public void stepOut() throws IOException

Implements com.amazon.ion.IonWriter.stepOut.

Doc from com.amazon.ion.IonWriter.stepOut.

Writes the end of the current container, returning this writer to the context of parent container. Invocation of this method must match a preceding call to stepIn(IonType).

topPendingComma	back to summary
pack-priv boolean topPendingComma()

topType	back to summary
pack-priv int topType() Returns:int a tid Exceptions ArrayIndexOutOfBoundsException: if _top < 1

writeAnnotations	back to summary
pack-priv void writeAnnotations(SymbolToken[] annotations) throws IOException

writeAnnotationToken	back to summary
pack-priv void writeAnnotationToken(SymbolToken ann) throws IOException

writeBlob back to summary

writeBlob	back to summary
public void writeBlob(byte[] value, int start, int len) throws IOException Implements com.amazon.ion.IonWriter.writeBlob. Doc from com.amazon.ion.IonWriter.writeBlob. Writes a portion of the byte array out as an IonBlob value. This copies the portion of the byte array that is written. Parameters value:byte[] bytes to be written. May be `null` to represent `null.blob`. start:int offset of the first byte in value to write len:int number of bytes to write from value

public void writeBlob(byte[] value, int start, int len) throws IOException

Implements com.amazon.ion.IonWriter.writeBlob.

Doc from com.amazon.ion.IonWriter.writeBlob.

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

Parameters

value:byte[]: bytes to be written. May be null to represent null.blob.
start:int: offset of the first byte in value to write
len:int: number of bytes to write from value

writeBool	back to summary
public void writeBool(boolean value) throws IOException Implements com.amazon.ion.IonWriter.writeBool. Doc from com.amazon.ion.IonWriter.writeBool. writes a non-null boolean value (true or false) as an IonBool to output. Parameters value:boolean true or false as desired

writeBool

back to summary

public void writeBool(boolean value) throws IOException

Implements com.amazon.ion.IonWriter.writeBool.

Doc from com.amazon.ion.IonWriter.writeBool.

writes a non-null boolean value (true or false) as an IonBool to output.

Parameters

value:boolean: true or false as desired

writeClob back to summary

writeClob	back to summary
public void writeClob(byte[] value, int start, int len) throws IOException Implements com.amazon.ion.IonWriter.writeClob. Doc from com.amazon.ion.IonWriter.writeClob. Writes a portion of the byte array out as an IonClob value. This copies the porition of the byte array that is written. Parameters value:byte[] bytes to be written. May be `null` to represent `null.clob`. start:int offset of the first byte in value to write len:int number of bytes to write from value

public void writeClob(byte[] value, int start, int len) throws IOException

Implements com.amazon.ion.IonWriter.writeClob.

Doc from com.amazon.ion.IonWriter.writeClob.

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

Parameters

value:byte[]: bytes to be written. May be null to represent null.clob.
start:int: offset of the first byte in value to write
len:int: number of bytes to write from value

writeDecimal back to summary

writeDecimal	back to summary
public void writeDecimal(BigDecimal value) throws IOException Implements abstract com.amazon.ion.impl._Private_IonWriterBase.writeDecimal. Implements com.amazon.ion.IonWriter.writeDecimal. Doc from com.amazon.ion.IonWriter.writeDecimal. Writes a BigDecimal value as an Ion decimal. Ion uses an arbitrarily long sign/value and an arbitrarily long signed exponent to write the value. This preserves all of the BigDecimal digits, the number of significant digits. To write a negative zero value, pass this method a `Decimal` instance. Parameters value:BigDecimal may be null to represent `null.decimal`. Annotations @Override

public void writeDecimal(BigDecimal value) throws IOException

Implements abstract com.amazon.ion.impl._Private_IonWriterBase.writeDecimal.

Implements com.amazon.ion.IonWriter.writeDecimal.

Doc from com.amazon.ion.IonWriter.writeDecimal.

Writes a BigDecimal value as an Ion decimal. Ion uses an arbitrarily long sign/value and an arbitrarily long signed exponent to write the value. This preserves all of the BigDecimal digits, the number of significant digits.

To write a negative zero value, pass this method a Decimal instance.

Parameters

value:BigDecimal: may be null to represent null.decimal.

Annotations

@Override

writeFieldNameToken	back to summary
pack-priv void writeFieldNameToken(SymbolToken sym) throws IOException

writeFloat	back to summary
public void writeFloat(double value) throws IOException Implements com.amazon.ion.IonWriter.writeFloat. Doc from com.amazon.ion.IonWriter.writeFloat. writes a 64 bit binary floating point value, a Java double, as an IonFloat. Currently IonFloat values are output as 64 bit IEEE 754 big endian values. IonFloat preserves all valid floating point values, including -0.0, Nan and +/-infinity. It does not guarantee preservation of -Nan or other less less "common" values. Parameters value:double double to write

writeFloat

back to summary

public void writeFloat(double value) throws IOException

Implements com.amazon.ion.IonWriter.writeFloat.

Doc from com.amazon.ion.IonWriter.writeFloat.

writes a 64 bit binary floating point value, a Java double, as an IonFloat. Currently IonFloat values are output as 64 bit IEEE 754 big endian values. IonFloat preserves all valid floating point values, including -0.0, Nan and +/-infinity. It does not guarantee preservation of -Nan or other less less "common" values.

Parameters

value:double: double to write

writeInt	back to summary
public void writeInt(long value) throws IOException Implements com.amazon.ion.IonWriter.writeInt. Doc from com.amazon.ion.IonWriter.writeInt. writes a signed 64 bit value, a Java long, as an IonInt. Parameters value:long signed int to write

writeInt

back to summary

public void writeInt(long value) throws IOException

Implements com.amazon.ion.IonWriter.writeInt.

Doc from com.amazon.ion.IonWriter.writeInt.

writes a signed 64 bit value, a Java long, as an IonInt.

Parameters

value:long: signed int to write

writeInt	back to summary
public void writeInt(BigInteger value) throws IOException Implements com.amazon.ion.IonWriter.writeInt. Doc from com.amazon.ion.IonWriter.writeInt. writes a BigInteger value as an IonInt. If the BigInteger value is null this writes a null int. Parameters value:BigInteger BigInteger to write

writeInt

back to summary

public void writeInt(BigInteger value) throws IOException

Implements com.amazon.ion.IonWriter.writeInt.

Doc from com.amazon.ion.IonWriter.writeInt.

writes a BigInteger value as an IonInt. If the BigInteger value is null this writes a null int.

Parameters

value:BigInteger: BigInteger to write

writeIonVersionMarkerAsIs back to summary

writeIonVersionMarkerAsIs	back to summary
pack-priv void writeIonVersionMarkerAsIs(SymbolTable systemSymtab) throws IOException Implements abstract com.amazon.ion.impl.IonWriterSystem.writeIonVersionMarkerAsIs. Doc from com.amazon.ion.impl.IonWriterSystem.writeIonVersionMarkerAsIs. Writes an IVM without checking preconditions or `InitialIVMHandling`. Annotations @Override

pack-priv void writeIonVersionMarkerAsIs(SymbolTable systemSymtab) throws IOException

Implements abstract com.amazon.ion.impl.IonWriterSystem.writeIonVersionMarkerAsIs.

Doc from com.amazon.ion.impl.IonWriterSystem.writeIonVersionMarkerAsIs.

Writes an IVM without checking preconditions or InitialIVMHandling.

Annotations

@Override

writeLocalSymtab	back to summary
pack-priv void writeLocalSymtab(SymbolTable symtab) throws IOException Overrides com.amazon.ion.impl.IonWriterSystem.writeLocalSymtab. Annotations @Override

writeLocalSymtab

back to summary

pack-priv void writeLocalSymtab(SymbolTable symtab) throws IOException

Overrides com.amazon.ion.impl.IonWriterSystem.writeLocalSymtab.

Annotations

@Override

writeNull back to summary

writeNull	back to summary
public void writeNull() throws IOException Overrides com.amazon.ion.impl._Private_IonWriterBase.writeNull. Implements com.amazon.ion.IonWriter.writeNull. Doc from com.amazon.ion.IonWriter.writeNull. Writes a value of Ion's null type (`null` aka `null.null`). Annotations @Override

public void writeNull() throws IOException

Overrides com.amazon.ion.impl._Private_IonWriterBase.writeNull.

Implements com.amazon.ion.IonWriter.writeNull.

Doc from com.amazon.ion.IonWriter.writeNull.

Writes a value of Ion's null type (null aka null.null).

Annotations

@Override

writeNull	back to summary
public void writeNull(IonType type) throws IOException Implements com.amazon.ion.IonWriter.writeNull. Doc from com.amazon.ion.IonWriter.writeNull. Writes a null value of a specified Ion type. Parameters type:IonType type of the null to be written

writeNull

back to summary

public void writeNull(IonType type) throws IOException

Implements com.amazon.ion.IonWriter.writeNull.

Doc from com.amazon.ion.IonWriter.writeNull.

Writes a null value of a specified Ion type.

Parameters

type:IonType: type of the null to be written

writeSeparator	back to summary
pack-priv boolean writeSeparator(boolean followingLongString) throws IOException

writeSidLiteral	back to summary
private void writeSidLiteral(int sid) throws IOException

writeString back to summary

public void writeString(String value) throws IOException

Implements com.amazon.ion.IonWriter.writeString.

Doc from com.amazon.ion.IonWriter.writeString.

Writes a java.lang.String as an Ion string. Since Ion strings are UTF-8 and Java Strings are Unicode 16. As such the resulting lengths may not match. In addition some Java strings are not valid as they may contain only one of the two needed surrogate code units necessary to define the Unicode code point to be output, an exception will be raised if this case is encountered.

Parameters