Modifier and Type	Class and Description
pack-priv static enum	AbstractIonWriter.WriteValueOptimization

Modifier and Type	Field and Description
private final _Private_SymtabExtendsCache	symtabExtendsCache The cache for copy optimization checks--null if not copy optimized.

Access	Constructor and Description
pack-priv	AbstractIonWriter(final AbstractIonWriter.WriteValueOptimization optimization)

Method Summary

Modifier and Type	Method and Description
public <T> T	asFacet(Class<T> The type token of the requested facet type. facetType) Implements com.amazon.ion.facet.Faceted.asFacet. Returns a facet of this subject if supported.
public final boolean	isStreamCopyOptimized() Implements com.amazon.ion.impl._Private_IonWriter.isStreamCopyOptimized. Indicates whether the writer is stream copy optimized through `writeValue(com.amazon.ion.IonReader)`.
public abstract void	writeString(byte[] 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 final void	writeTimestampUTC(final Date java.util Date holding the UTC timestamp; may be null to represent `null.timestamp`. value) Implements com.amazon.ion.IonWriter.writeTimestampUTC. writes the passed in Date (in milliseconds since the epoch) as an IonTimestamp.
public final void	writeValue(final IonValue may be null, in which case this method does nothing. value) Implements com.amazon.ion.IonWriter.writeValue. writes the contents of the passed in Ion value to the output.
public final void	writeValue(final IonReader reader) Implements com.amazon.ion.IonWriter.writeValue. Writes the current value from a reader.
public final void	writeValueRecursive(final IonReader The IonReader that will provide a value to write. reader) Performs a depth-first (recursive-like) traversal of the IonReader's current value, writing all values and annotations encountered during the traversal.
public final void	writeValues(final IonReader reader) Implements com.amazon.ion.IonWriter.writeValues. Writes a reader's current value, and all following values until the end of the current container.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

symtabExtendsCache	back to summary
private final _Private_SymtabExtendsCache symtabExtendsCache The cache for copy optimization checks--null if not copy optimized.

Constructor Detail

AbstractIonWriter	back to summary
pack-priv AbstractIonWriter(final AbstractIonWriter.WriteValueOptimization optimization)

Method Detail

asFacet	back to summary
public <T> T asFacet(Class<T> facetType) Implements com.amazon.ion.facet.Faceted.asFacet. Doc from com.amazon.ion.facet.Faceted.asFacet. Returns a facet of this subject if supported. Parameters <T> The requested facet type. facetType:Class<T> The type token of the requested facet type. Returns:T An instance of T representing the facet of the subject, or null if the facet is not supported by the subject. Annotations @SuppressWarnings:deprecation

asFacet

back to summary

public <T> T asFacet(Class<T> facetType)

Implements com.amazon.ion.facet.Faceted.asFacet.

Doc from com.amazon.ion.facet.Faceted.asFacet.

Returns a facet of this subject if supported.

Parameters

<T>: The requested facet type.
facetType:Class<T>: The type token of the requested facet type.

Returns:T

An instance of T representing the facet of the subject, or null if the facet is not supported by the subject.

Annotations

@SuppressWarnings:deprecation

isStreamCopyOptimized back to summary

isStreamCopyOptimized	back to summary
public final boolean isStreamCopyOptimized() Implements com.amazon.ion.impl._Private_IonWriter.isStreamCopyOptimized. Doc from com.amazon.ion.impl._Private_IonWriter.isStreamCopyOptimized. Indicates whether the writer is stream copy optimized through `writeValue(com.amazon.ion.IonReader)`.

public final boolean isStreamCopyOptimized()

Implements com.amazon.ion.impl._Private_IonWriter.isStreamCopyOptimized.

Doc from com.amazon.ion.impl._Private_IonWriter.isStreamCopyOptimized.

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

writeString back to summary

writeString	back to summary
public abstract 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[] 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)`

public abstract 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[]: 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

writeTimestampUTC back to summary

writeTimestampUTC	back to summary
public final void writeTimestampUTC(final Date value) throws IOException Implements com.amazon.ion.IonWriter.writeTimestampUTC. Doc from com.amazon.ion.IonWriter.writeTimestampUTC. writes the passed in Date (in milliseconds since the epoch) as an IonTimestamp. The Date value is treated as a UTC value with an unknown timezone offset (a z value). Parameters value:Date java.util Date holding the UTC timestamp; may be null to represent `null.timestamp`.

public final void writeTimestampUTC(final Date value) throws IOException

Implements com.amazon.ion.IonWriter.writeTimestampUTC.

Doc from com.amazon.ion.IonWriter.writeTimestampUTC.

writes the passed in Date (in milliseconds since the epoch) as an IonTimestamp. The Date value is treated as a UTC value with an unknown timezone offset (a z value).

Parameters

value:Date: java.util Date holding the UTC timestamp; may be null to represent null.timestamp.

writeValue	back to summary
public final void writeValue(final IonValue value) throws IOException Implements com.amazon.ion.IonWriter.writeValue. Doc from com.amazon.ion.IonWriter.writeValue. writes the contents of the passed in Ion value to the output. This method also writes annotations and field names (if in a struct), and performs a deep write, including the contents of any containers encountered. Parameters value:IonValue may be null, in which case this method does nothing.

writeValue

back to summary

public final void writeValue(final IonValue value) throws IOException

Implements com.amazon.ion.IonWriter.writeValue.

Doc from com.amazon.ion.IonWriter.writeValue.

writes the contents of the passed in Ion value to the output.

This method also writes annotations and field names (if in a struct), and performs a deep write, including the contents of any containers encountered.

Parameters

value:IonValue: may be null, in which case this method does nothing.

writeValue	back to summary
public final void writeValue(final IonReader reader) throws IOException Implements com.amazon.ion.IonWriter.writeValue. Doc from com.amazon.ion.IonWriter.writeValue. Writes the current value from a reader. This method also writes annotations and field names (if in a struct), and performs a deep write, including the contents of any containers encountered.

writeValue

back to summary

public final void writeValue(final IonReader reader) throws IOException

Implements com.amazon.ion.IonWriter.writeValue.

Doc from com.amazon.ion.IonWriter.writeValue.

Writes the current value from a reader.

This method also writes annotations and field names (if in a struct), and performs a deep write, including the contents of any containers encountered.

writeValueRecursive	back to summary
public final void writeValueRecursive(final IonReader reader) throws IOException Performs a depth-first (recursive-like) traversal of the IonReader's current value, writing all values and annotations encountered during the traversal. This method is not implemented using recursion. Parameters reader:IonReader The IonReader that will provide a value to write. Exceptions IOException: if either the provided IonReader or this writer's underlying OutputStream throw an IOException. IllegalStateException: if this writer is inside a struct but the IonReader is not.

writeValueRecursive

back to summary

public final void writeValueRecursive(final IonReader reader) throws IOException

Performs a depth-first (recursive-like) traversal of the IonReader's current value, writing all values and annotations encountered during the traversal. This method is not implemented using recursion.

Parameters

reader:IonReader: The IonReader that will provide a value to write.

Exceptions

IOException:: if either the provided IonReader or this writer's underlying OutputStream throw an IOException.
IllegalStateException:: if this writer is inside a struct but the IonReader is not.

writeValues back to summary

writeValues	back to summary
public final void writeValues(final IonReader reader) throws IOException Implements com.amazon.ion.IonWriter.writeValues. Doc from com.amazon.ion.IonWriter.writeValues. Writes a reader's current value, and all following values until the end of the current container. If there's no current value then this method calls `IonReader#next()` to get going. This method iterates until `IonReader#next()` returns `null` and does not step out to the container of the current cursor position. This method also writes annotations and field names (if in a struct), and performs a deep write, including the contents of any containers encountered.

public final void writeValues(final IonReader reader) throws IOException

Implements com.amazon.ion.IonWriter.writeValues.

Doc from com.amazon.ion.IonWriter.writeValues.

Writes a reader's current value, and all following values until the end of the current container. If there's no current value then this method calls IonReader#next() to get going.

This method iterates until IonReader#next() returns null and does not step out to the container of the current cursor position.

This method also writes annotations and field names (if in a struct), and performs a deep write, including the contents of any containers encountered.

com.amazon.ion.impl.bin back to summary

pack-priv final Enum AbstractIonWriter.WriteValueOptimization

Class Inheritance

extends Enum<AbstractIonWriter.WriteValueOptimization>

java.lang.Object
java.lang.Enum
com.amazon.ion.impl.bin.AbstractIonWriter.WriteValueOptimization

Field Summary

Modifier and Type	Field and Description
public static final AbstractIonWriter.WriteValueOptimization	COPY_OPTIMIZED
public static final AbstractIonWriter.WriteValueOptimization	NONE

Constructor Summary

Access	Constructor and Description
private	WriteValueOptimization()

Method Summary

Modifier and Type	Method and Description
public static AbstractIonWriter.WriteValueOptimization	valueOf(String name)
public static AbstractIonWriter.WriteValueOptimization[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

COPY_OPTIMIZED	back to summary
public static final AbstractIonWriter.WriteValueOptimization COPY_OPTIMIZED

NONE	back to summary
public static final AbstractIonWriter.WriteValueOptimization NONE

Constructor Detail

WriteValueOptimization	back to summary
private WriteValueOptimization()

Method Detail

valueOf	back to summary
public static AbstractIonWriter.WriteValueOptimization valueOf(String name)

values	back to summary
public static AbstractIonWriter.WriteValueOptimization[] values()

pack-priv abstract Class AbstractIonWriter

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Enum AbstractIonWriter.WriteValueOptimization

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail