Modifier and Type	Class and Description
private static class	IonContainerLite.CloneContext
protected class	IonContainerLite.SequenceContentIterator Encapsulates an iterator and implements a custom remove method

Modifier and Type	Field and Description
protected int	_child_count
protected IonValueLite[]	_children
pack-priv static final int[]	INITIAL_SIZE sizes for the various types of containers expected to be tuned.
protected IonSystemLite	ionSystem
pack-priv static final int[]	NEXT_SIZE
pack-priv static final int	STRUCT_INITIAL_SIZE
protected int	structuralModificationCount

Access	Constructor and Description
protected	IonContainerLite(ContainerlessContext context, boolean isNull)
pack-priv	IonContainerLite(IonContainerLite existing, IonContext context)

Method Summary

Modifier and Type	Method and Description
public abstract void	accept(ValueVisitor will have one of its `visit` methods called. visitor) Redeclares com.amazon.ion.IonValue.accept. Implements abstract com.amazon.ion.impl.lite.IonValueLite.accept. Entry point for visitor pattern.
public boolean	add(IonValue child)
pack-priv void	add(int index, IonValueLite must not be null. child) Validates the child and checks locks.
protected int	add_child(int idx, IonValueLite child) Does not validate the child or check locks.
pack-priv void	afterIteratorRemove(IonValueLite the value that was removed. value, int the container index of the value that was removed. idx) Called after a value is removed from the SequenceContentIterator.
pack-priv void	beforeIteratorRemove(IonValueLite the value that will be removed. value, int the container index of the value that will be removed. idx) Called before a value is removed from the SequenceContentIterator.
public void	clear() Implements com.amazon.ion.IonContainer.clear. Clears the contents of this container (if any) and set it to empty.
public IonContainer	clone() Implements abstract com.amazon.ion.impl.lite.IonValueLite.clone. Implements com.amazon.ion.IonContainer.clone, com.amazon.ion.IonValue.clone. Creates a copy of this value and all of its children.
pack-priv final IonContainerLite	Returns: the clone. deepClone(boolean true if the value to be cloned is an IonDatagram; otherwise, false. isDatagramBeingCloned) Clones the container by walking it iteratively.
private void	detachAllChildren()
pack-priv void	forceMaterializationOfLazyState() Force any lazy state to be materialized (if applicable).
public IonValue	get(int index)
public final IonValueLite	get_child(int idx) Implements com.amazon.ion.impl._Private_IonContainer.get_child.
public final int	get_child_count() Implements com.amazon.ion.impl._Private_IonContainer.get_child_count.
public final IonContainerLite	getContextContainer() Implements com.amazon.ion.impl.lite.IonContext.getContextContainer. methods from IonValue public void deepMaterialize() public IonContainer getContainer() public int getFieldId() public String getFieldName() public String[] getTypeAnnotations() public boolean hasTypeAnnotation(String annotation) public boolean isNullValue() public boolean isReadOnly() public void removeTypeAnnotation(String annotation)
pack-priv IonContext	getContextForIndex(IonValue element, int index)
public final SymbolTable	Returns: `null`, since symbol tables are only directly assigned to top-level values. getContextSymbolTable() Implements com.amazon.ion.impl.lite.IonContext.getContextSymbolTable. Returns the symbol table that is directly assigned to this context.
public IonSystemLite	getSystem() Overrides com.amazon.ion.impl.lite.IonValueLite.getSystem. Implements com.amazon.ion.IonValue.getSystem, com.amazon.ion.impl.lite.IonContext.getSystem. Get the IonSystem concrete object that created the IonValue that is associated with this context.
protected final int	initialSize()
public boolean	isEmpty() Implements com.amazon.ion.IonContainer.isEmpty. Checks if this container is empty.
public final Iterator<IonValue>	iterator() Implements com.amazon.ion.IonContainer.iterator. Creates an iterator providing the (direct) elements of this container.
public final ListIterator<IonValue>	listIterator()
public ListIterator<IonValue>	listIterator(int index)
pack-priv static int[]	make_initial_size_array()
pack-priv static int[]	make_next_size_array()
public void	makeNull() Implements com.amazon.ion.IonContainer.makeNull. Sets the contents of this container to an Ion `null` value.
protected final int	nextSize(int current_size, boolean call_transition)
public final void	patch_elements_helper(int lowest_bad_idx)
public boolean	remove(IonValue the element to be removed from this container, if present. element) Implements com.amazon.ion.IonContainer.remove. Removes the given element from this container.
pack-priv void	remove_child(int idx) Does not check locks.
pack-priv final int	scalarHashCode() Implements abstract com.amazon.ion.impl.lite.IonValueLite.scalarHashCode. Internal HashCode implementation to be overridden by scalar subclasses.
pack-priv final IonValueLite	set_child(int idx, IonValueLite child)
private static void	setCloneContext(IonContainerLite.CloneContext the context to fill in. cloneContext, IonContainerLite the container being cloned. containerOriginal, IonContainerLite the container clone. containerCopy, boolean true if the value being cloned is a child of a datagram. needsTopLevelContext) Prepares a CloneContext for the container that is about to be walked.
public int	size() Implements com.amazon.ion.IonContainer.size. Returns the number of elements in this container.
pack-priv void	transitionToLargeSize(int size) This is overridden in `IonStructLite` to add the `HashMap` of field names when the struct becomes moderately large.
pack-priv void	validateNewChild(IonValue child) Ensures that a potential new child is non-null, has no container, is not read-only, and is not a datagram.
pack-priv final void	writeBodyTo(IonWriter an IonWriter. writer, _Private_IonValue.SymbolTableProvider a SymbolTableProvider. symbolTableProvider) Implements abstract com.amazon.ion.impl.lite.IonValueLite.writeBodyTo. Writes a non-null scalar value to the given writer.

Inherited from com.amazon.ion.impl.lite.IonValueLite:: _elementid _elementid _getMetadata _isAutoCreated _isAutoCreated _isBoolTrue _isBoolTrue _isIVM _isIVM _isLocked _isLocked _isNullValue _isNullValue _isSymbolIdPresent _isSymbolIdPresent _isSymbolPresent _isSymbolPresent _isSystemValue _isSystemValue _setMetadata addTypeAnnotation attemptClearSymbolIDValues cascadeSIDPresentToContextRoot checkAnnotationsForSids checkForLock clearSymbolIDValues clearTypeAnnotations copyFieldName detachFromContainer dump equals findTypeAnnotation getAssignedSymbolTable getContainer getContext getElementId getFieldId getFieldName getFieldNameId getFieldNameSymbol getFieldNameSymbol getKnownFieldNameSymbol getSymbolTable getType getTypeAnnotations getTypeAnnotationSymbols getTypeAnnotationSymbols getTypeSlow hashCode hashSignature hashTypeAnnotations hasTypeAnnotation isNullValue isReadOnly makeReadOnly makeReadOnlyInternal removeFromContainer removeTypeAnnotation setContext setFieldName setFieldNameSymbol setSymbolTable setTypeAnnotations setTypeAnnotationSymbols shallowClone topLevelValue toPrettyString toString toString validate validateThisNotNull writeTo writeTo

Field Detail

_child_count	back to summary
protected int _child_count

_children	back to summary
protected IonValueLite[] _children

INITIAL_SIZE	back to summary
pack-priv static final int[] INITIAL_SIZE sizes for the various types of containers expected to be tuned.

ionSystem	back to summary
protected IonSystemLite ionSystem

NEXT_SIZE	back to summary
pack-priv static final int[] NEXT_SIZE

STRUCT_INITIAL_SIZE	back to summary
pack-priv static final int STRUCT_INITIAL_SIZE

structuralModificationCount	back to summary
protected int structuralModificationCount

Constructor Detail

IonContainerLite	back to summary
protected IonContainerLite(ContainerlessContext context, boolean isNull)

IonContainerLite	back to summary
pack-priv IonContainerLite(IonContainerLite existing, IonContext context)

Method Detail

accept back to summary

accept	back to summary
public abstract void accept(ValueVisitor visitor) throws Exception Redeclares com.amazon.ion.IonValue.accept. Implements abstract com.amazon.ion.impl.lite.IonValueLite.accept. Doc from com.amazon.ion.IonValue.accept. Entry point for visitor pattern. Implementations of this method by concrete classes will simply call the appropriate `visit` method on the `visitor`. For example, instances of `IonBool` will invoke `ValueVisitor#visit(IonBool)`. Parameters visitor:ValueVisitor will have one of its `visit` methods called. Annotations @Override Exceptions Exception: any exception thrown by the visitor is propagated.

public abstract void accept(ValueVisitor visitor) throws Exception

Redeclares com.amazon.ion.IonValue.accept.

Implements abstract com.amazon.ion.impl.lite.IonValueLite.accept.

Doc from com.amazon.ion.IonValue.accept.

Entry point for visitor pattern. Implementations of this method by concrete classes will simply call the appropriate visit method on the visitor. For example, instances of IonBool will invoke ValueVisitor#visit(IonBool).

Parameters

visitor:ValueVisitor: will have one of its visit methods called.

Annotations

@Override

Exceptions

Exception:: any exception thrown by the visitor is propagated.

add	back to summary
public boolean add(IonValue child) throws NullPointerException, IllegalArgumentException, ContainedValueException

add back to summary

add	back to summary
pack-priv void add(int index, IonValueLite child) throws ContainedValueException, NullPointerException Validates the child and checks locks. Parameters child:IonValueLite must not be null. Exceptions NullPointerException: if the element is `null`. IndexOutOfBoundsException: if the index is out of range (index < 0 \|\| index > size()).

pack-priv void add(int index, IonValueLite child) throws ContainedValueException, NullPointerException

Validates the child and checks locks.

Parameters

child:IonValueLite: must not be null.

Exceptions

NullPointerException:: if the element is null.
IndexOutOfBoundsException:: if the index is out of range (index < 0 || index > size()).

add_child	back to summary
protected int add_child(int idx, IonValueLite child) Does not validate the child or check locks.

afterIteratorRemove	back to summary
pack-priv void afterIteratorRemove(IonValueLite value, int idx) Called after a value is removed from the SequenceContentIterator. May be overridden by subclasses that require custom behavior. Parameters value:IonValueLite the value that was removed. idx:int the container index of the value that was removed.

afterIteratorRemove

back to summary

pack-priv void afterIteratorRemove(IonValueLite value, int idx)

Called after a value is removed from the SequenceContentIterator. May be overridden by subclasses that require custom behavior.

Parameters

value:IonValueLite: the value that was removed.
idx:int: the container index of the value that was removed.

beforeIteratorRemove	back to summary
pack-priv void beforeIteratorRemove(IonValueLite value, int idx) Called before a value is removed from the SequenceContentIterator. May be overridden by subclasses that require custom behavior. Parameters value:IonValueLite the value that will be removed. idx:int the container index of the value that will be removed.

beforeIteratorRemove

back to summary

pack-priv void beforeIteratorRemove(IonValueLite value, int idx)

Called before a value is removed from the SequenceContentIterator. May be overridden by subclasses that require custom behavior.

Parameters

value:IonValueLite: the value that will be removed.
idx:int: the container index of the value that will be removed.

clear back to summary

clear	back to summary
public void clear() Implements com.amazon.ion.IonContainer.clear. Doc from com.amazon.ion.IonContainer.clear. Clears the contents of this container (if any) and set it to empty. If this container is an Ion `null` value, set it to empty. Use `makeNull` to make this container null rather than empty. Warning This method is not support for instances of `IonDatagram`.

public void clear()

Implements com.amazon.ion.IonContainer.clear.

Doc from com.amazon.ion.IonContainer.clear.

Clears the contents of this container (if any) and set it to empty. If this container is an Ion null value, set it to empty.

Use makeNull to make this container null rather than empty.

Warning

This method is not support for instances of IonDatagram.

clone back to summary

clone	back to summary
public IonContainer clone() Implements abstract com.amazon.ion.impl.lite.IonValueLite.clone. Implements com.amazon.ion.IonContainer.clone, com.amazon.ion.IonValue.clone. Doc from com.amazon.ion.IonValue.clone. Creates a copy of this value and all of its children. The cloned value may use the same shared symbol tables, but it will have an independent local symbol table if necessary. The cloned value will be modifiable regardless of whether this instance `isReadOnly()`. The cloned value will be created in the context of the same `ValueFactory` as this instance; if you want a copy using a different factory, then use `ValueFactory#clone(IonValue)` instead. Returns:IonContainer Doc from java.lang.Object.clone. a clone of this instance. Annotations @Override

public IonContainer clone()

Implements abstract com.amazon.ion.impl.lite.IonValueLite.clone.

Implements com.amazon.ion.IonContainer.clone, com.amazon.ion.IonValue.clone.

Doc from com.amazon.ion.IonValue.clone.

Creates a copy of this value and all of its children. The cloned value may use the same shared symbol tables, but it will have an independent local symbol table if necessary. The cloned value will be modifiable regardless of whether this instance isReadOnly().

The cloned value will be created in the context of the same ValueFactory as this instance; if you want a copy using a different factory, then use ValueFactory#clone(IonValue) instead.

Returns:IonContainer

Doc from java.lang.Object.clone.

a clone of this instance.

Annotations

@Override

deepClone	back to summary
pack-priv final IonContainerLite deepClone(boolean isDatagramBeingCloned) Clones the container by walking it iteratively. Parameters isDatagramBeingCloned:boolean true if the value to be cloned is an IonDatagram; otherwise, false. Returns:IonContainerLite the clone.

deepClone

back to summary

pack-priv final IonContainerLite deepClone(boolean isDatagramBeingCloned)

Clones the container by walking it iteratively.

Parameters

isDatagramBeingCloned:boolean: true if the value to be cloned is an IonDatagram; otherwise, false.

Returns:IonContainerLite

the clone.

detachAllChildren	back to summary
private void detachAllChildren()

forceMaterializationOfLazyState	back to summary
pack-priv void forceMaterializationOfLazyState() Force any lazy state to be materialized (if applicable).

get	back to summary
public IonValue get(int index) throws NullValueException

get_child	back to summary
public final IonValueLite get_child(int idx) Implements com.amazon.ion.impl._Private_IonContainer.get_child.

get_child_count	back to summary
public final int get_child_count() Implements com.amazon.ion.impl._Private_IonContainer.get_child_count.

getContextContainer	back to summary
public final IonContainerLite getContextContainer() Implements com.amazon.ion.impl.lite.IonContext.getContextContainer. methods from IonValue public void deepMaterialize() public IonContainer getContainer() public int getFieldId() public String getFieldName() public String[] getTypeAnnotations() public boolean hasTypeAnnotation(String annotation) public boolean isNullValue() public boolean isReadOnly() public void removeTypeAnnotation(String annotation) Returns:IonContainerLite Doc from com.amazon.ion.impl.lite.IonContext.getContextContainer. the container of the value; null for stand-alone top level values.

getContextContainer

back to summary

public final IonContainerLite getContextContainer()

Implements com.amazon.ion.impl.lite.IonContext.getContextContainer.

methods from IonValue public void deepMaterialize() public IonContainer getContainer() public int getFieldId() public String getFieldName() public String[] getTypeAnnotations() public boolean hasTypeAnnotation(String annotation) public boolean isNullValue() public boolean isReadOnly() public void removeTypeAnnotation(String annotation)

Returns:IonContainerLite

Doc from com.amazon.ion.impl.lite.IonContext.getContextContainer.

the container of the value; null for stand-alone top level values.

getContextForIndex	back to summary
pack-priv IonContext getContextForIndex(IonValue element, int index)

getContextSymbolTable back to summary

getContextSymbolTable	back to summary
public final SymbolTable getContextSymbolTable() Implements com.amazon.ion.impl.lite.IonContext.getContextSymbolTable. Doc from com.amazon.ion.impl.lite.IonContext.getContextSymbolTable. Returns the symbol table that is directly assigned to this context. For `TopLevelContext` it is the symbol table member. For `IonContainerLite` and `IonSystemLite` it is null. Returns:SymbolTable `null`, since symbol tables are only directly assigned to top-level values.

public final SymbolTable getContextSymbolTable()

Implements com.amazon.ion.impl.lite.IonContext.getContextSymbolTable.

Doc from com.amazon.ion.impl.lite.IonContext.getContextSymbolTable.

Returns the symbol table that is directly assigned to this context. For TopLevelContext it is the symbol table member. For IonContainerLite and IonSystemLite it is null.

Returns:SymbolTable: null, since symbol tables are only directly assigned to top-level values.

getSystem	back to summary
public IonSystemLite getSystem() Overrides com.amazon.ion.impl.lite.IonValueLite.getSystem. Implements com.amazon.ion.IonValue.getSystem, com.amazon.ion.impl.lite.IonContext.getSystem. Doc from com.amazon.ion.impl.lite.IonContext.getSystem. Get the IonSystem concrete object that created the IonValue that is associated with this context. Generally this delegates to the parent. Returns:IonSystemLite not null Annotations @Override

getSystem

back to summary

public IonSystemLite getSystem()

Overrides com.amazon.ion.impl.lite.IonValueLite.getSystem.

Implements com.amazon.ion.IonValue.getSystem, com.amazon.ion.impl.lite.IonContext.getSystem.

Doc from com.amazon.ion.impl.lite.IonContext.getSystem.

Get the IonSystem concrete object that created the IonValue that is associated with this context. Generally this delegates to the parent.

Returns:IonSystemLite

not null

Annotations

@Override

initialSize	back to summary
protected final int initialSize()

isEmpty back to summary

isEmpty	back to summary
public boolean isEmpty() throws NullValueException Implements com.amazon.ion.IonContainer.isEmpty. Doc from com.amazon.ion.IonContainer.isEmpty. Checks if this container is empty. Returns:boolean `true` if this container has no contents Exceptions NullValueException: if this container is an Ion `null` value

public boolean isEmpty() throws NullValueException

Implements com.amazon.ion.IonContainer.isEmpty.

Doc from com.amazon.ion.IonContainer.isEmpty.

Checks if this container is empty.

Returns:boolean

true if this container has no contents

Exceptions

NullValueException:: if this container is an Ion null value

iterator back to summary

iterator	back to summary
public final Iterator<IonValue> iterator() Implements com.amazon.ion.IonContainer.iterator. Doc from com.amazon.ion.IonContainer.iterator. Creates an iterator providing the (direct) elements of this container. If this is an Ion null value, then this method returns an empty iterator. Note that iteration over a `IonStruct` has unspecified ordering, while iteration over an `IonSequence` (`IonList` or `IonSexp`) must return elements in order of their appearance in the Ion representation. Returns:Iterator<IonValue> a new iterator, not `null`.

public final Iterator<IonValue> iterator()

Implements com.amazon.ion.IonContainer.iterator.

Doc from com.amazon.ion.IonContainer.iterator.

Creates an iterator providing the (direct) elements of this container. If this is an Ion null value, then this method returns an empty iterator.

Note that iteration over a IonStruct has unspecified ordering, while iteration over an IonSequence (IonList or IonSexp) must return elements in order of their appearance in the Ion representation.

Returns:Iterator<IonValue>: a new iterator, not null.

listIterator	back to summary
public final ListIterator<IonValue> listIterator()

listIterator	back to summary
public ListIterator<IonValue> listIterator(int index)

make_initial_size_array	back to summary
pack-priv static int[] make_initial_size_array()

make_next_size_array	back to summary
pack-priv static int[] make_next_size_array()

makeNull back to summary

makeNull	back to summary
public void makeNull() Implements com.amazon.ion.IonContainer.makeNull. Doc from com.amazon.ion.IonContainer.makeNull. Sets the contents of this container to an Ion `null` value. Use `clear` to make this container empty rather than null.

public void makeNull()

Implements com.amazon.ion.IonContainer.makeNull.

Doc from com.amazon.ion.IonContainer.makeNull.

Sets the contents of this container to an Ion null value.

Use clear to make this container empty rather than null.

nextSize	back to summary
protected final int nextSize(int current_size, boolean call_transition)

patch_elements_helper	back to summary
public final void patch_elements_helper(int lowest_bad_idx)

remove back to summary

remove	back to summary
public boolean remove(IonValue element) Implements com.amazon.ion.IonContainer.remove. Doc from com.amazon.ion.IonContainer.remove. Removes the given element from this container. If this is an Ion null value, then this method returns `false`. Note that, unlike `Collection#remove(Object)`, this method uses object identity, not `Object#equals(Object)`, to find the element. That is, the given instance is removed, not other similarly "equal" instances. Parameters element:IonValue the element to be removed from this container, if present. Returns:boolean `true` if this container contained the specified element.

public boolean remove(IonValue element)

Implements com.amazon.ion.IonContainer.remove.

Doc from com.amazon.ion.IonContainer.remove.

Removes the given element from this container. If this is an Ion null value, then this method returns false.

Note that, unlike Collection#remove(Object), this method uses object identity, not Object#equals(Object), to find the element. That is, the given instance is removed, not other similarly "equal" instances.

Parameters

element:IonValue: the element to be removed from this container, if present.

Returns:boolean

true if this container contained the specified element.

remove_child	back to summary
pack-priv void remove_child(int idx) Does not check locks.

scalarHashCode	back to summary
pack-priv final int scalarHashCode() Implements abstract com.amazon.ion.impl.lite.IonValueLite.scalarHashCode. Doc from com.amazon.ion.impl.lite.IonValueLite.scalarHashCode. Internal HashCode implementation to be overridden by scalar subclasses. Must only be called on non-null values. Annotations @Override

scalarHashCode

back to summary

pack-priv final int scalarHashCode()

Implements abstract com.amazon.ion.impl.lite.IonValueLite.scalarHashCode.

Doc from com.amazon.ion.impl.lite.IonValueLite.scalarHashCode.

Internal HashCode implementation to be overridden by scalar subclasses. Must only be called on non-null values.

Annotations

@Override

set_child	back to summary
pack-priv final IonValueLite set_child(int idx, IonValueLite child)

setCloneContext	back to summary
private static void setCloneContext(IonContainerLite.CloneContext cloneContext, IonContainerLite containerOriginal, IonContainerLite containerCopy, boolean needsTopLevelContext) Prepares a CloneContext for the container that is about to be walked. Parameters cloneContext:IonContainerLite.CloneContext the context to fill in. containerOriginal:IonContainerLite the container being cloned. containerCopy:IonContainerLite the container clone. needsTopLevelContext:boolean true if the value being cloned is a child of a datagram.

setCloneContext

back to summary

private static void setCloneContext(IonContainerLite.CloneContext cloneContext, IonContainerLite containerOriginal, IonContainerLite containerCopy, boolean needsTopLevelContext)

Prepares a CloneContext for the container that is about to be walked.

Parameters

cloneContext:IonContainerLite.CloneContext: the context to fill in.
containerOriginal:IonContainerLite: the container being cloned.
containerCopy:IonContainerLite: the container clone.
needsTopLevelContext:boolean: true if the value being cloned is a child of a datagram.

size back to summary

size	back to summary
public int size() Implements com.amazon.ion.IonContainer.size. Doc from com.amazon.ion.IonContainer.size. Returns the number of elements in this container. Returns:int the number of elements, zero if `this.isNullValue()`.

public int size()

Implements com.amazon.ion.IonContainer.size.

Doc from com.amazon.ion.IonContainer.size.

Returns the number of elements in this container.

Returns:int: the number of elements, zero if this.isNullValue().

transitionToLargeSize	back to summary
pack-priv void transitionToLargeSize(int size) This is overridden in `IonStructLite` to add the `HashMap` of field names when the struct becomes moderately large.

validateNewChild back to summary

validateNewChild	back to summary
pack-priv void validateNewChild(IonValue child) throws ContainedValueException, NullPointerException, IllegalArgumentException Ensures that a potential new child is non-null, has no container, is not read-only, and is not a datagram. Exceptions ContainedValueException: if `child` is already part of a container. NullPointerException: if `child` is `null`. IllegalArgumentException: if `child` is an `IonDatagram`. ReadOnlyValueException: if `child` is read only.

pack-priv void validateNewChild(IonValue child) throws ContainedValueException, NullPointerException, IllegalArgumentException

Ensures that a potential new child is non-null, has no container, is not read-only, and is not a datagram.

Exceptions

ContainedValueException:: if child is already part of a container.
NullPointerException:: if child is null.
IllegalArgumentException:: if child is an IonDatagram.
ReadOnlyValueException:: if child is read only.

writeBodyTo	back to summary
pack-priv final void writeBodyTo(IonWriter writer, _Private_IonValue.SymbolTableProvider symbolTableProvider) throws IOException Implements abstract com.amazon.ion.impl.lite.IonValueLite.writeBodyTo. Doc from com.amazon.ion.impl.lite.IonValueLite.writeBodyTo. Writes a non-null scalar value to the given writer. It is incorrect to call this method on a container value. Parameters writer:IonWriter an IonWriter. symbolTableProvider:_Private_IonValue.SymbolTableProvider a SymbolTableProvider. Annotations @Override Exceptions IOException: if thrown when writing the value.

writeBodyTo

back to summary

pack-priv final void writeBodyTo(IonWriter writer, _Private_IonValue.SymbolTableProvider symbolTableProvider) throws IOException

Implements abstract com.amazon.ion.impl.lite.IonValueLite.writeBodyTo.

Doc from com.amazon.ion.impl.lite.IonValueLite.writeBodyTo.

Writes a *non-null scalar* value to the given writer. It is incorrect to call this method on a container value.

Parameters

writer:IonWriter: an IonWriter.
symbolTableProvider:_Private_IonValue.SymbolTableProvider: a SymbolTableProvider.

Annotations

@Override

Exceptions

IOException:: if thrown when writing the value.

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

private Class IonContainerLite.CloneContext

Class Inheritance

extends Object

java.lang.Object
com.amazon.ion.impl.lite.IonContainerLite.CloneContext

Field Summary

Modifier and Type	Field and Description
pack-priv int	childIndex
pack-priv IonContext	contextCopy
pack-priv IonContainerLite	parentCopy
pack-priv boolean	parentIsStruct
pack-priv IonContainerLite	parentOriginal

Constructor Summary

Access	Constructor and Description
private	CloneContext()

Method Summary

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

Field Detail

childIndex	back to summary
pack-priv int childIndex

contextCopy	back to summary
pack-priv IonContext contextCopy

parentCopy	back to summary
pack-priv IonContainerLite parentCopy

parentIsStruct	back to summary
pack-priv boolean parentIsStruct

parentOriginal	back to summary
pack-priv IonContainerLite parentOriginal

Constructor Detail

CloneContext	back to summary
private CloneContext()

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

protected Class IonContainerLite.SequenceContentIterator

Class Inheritance

extends Object
implements ListIterator<IonValue>

java.lang.Object
com.amazon.ion.impl.lite.IonContainerLite.SequenceContentIterator

All Implemented Interfaces

java.util.ListIterator, java.util.Iterator

Encapsulates an iterator and implements a custom remove method

Field Summary

Modifier and Type	Field and Description
protected IonValueLite	__current
protected boolean	__lastMoveWasPrevious
protected int	__pos
protected final boolean	__readOnly

Constructor Summary

Access	Constructor and Description
public	SequenceContentIterator(int index, boolean readOnly)

Method Summary

Modifier and Type	Method and Description
public void	add(IonValue the element to insert element) Implements java.util.ListIterator.add. Inserts the specified element into the list (optional operation).
protected final void	force_position_sync()
private final void	force_position_sync_helper()
public final boolean	hasNext() Implements java.util.ListIterator.hasNext. Returns `true` if this list iterator has more elements when traversing the list in the forward direction.
public final boolean	hasPrevious() Implements java.util.ListIterator.hasPrevious. Returns `true` if this list iterator has more elements when traversing the list in the reverse direction.
public IonValue	next() Implements java.util.ListIterator.next. Returns the next element in the list and advances the cursor position.
public final int	nextIndex() Implements java.util.ListIterator.nextIndex. Returns the index of the element that would be returned by a subsequent call to `next`.
pack-priv IonValueLite	nextOrNull() Returns the next element, or null if there are no more elements.
public IonValue	previous() Implements java.util.ListIterator.previous. Returns the previous element in the list and moves the cursor position backwards.
public final int	previousIndex() Implements java.util.ListIterator.previousIndex. Returns the index of the element that would be returned by a subsequent call to `previous`.
public void	remove() Implements java.util.ListIterator.remove. Sets the container to dirty after calling `Iterator#remove()` on the encapsulated iterator
public void	set(IonValue the element with which to replace the last element returned by `next` or `previous` element) Implements java.util.ListIterator.set. Replaces the last element returned by `next` or `previous` with the specified element (optional operation).

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

Field Detail

__current	back to summary
protected IonValueLite __current

__lastMoveWasPrevious	back to summary
protected boolean __lastMoveWasPrevious

__pos	back to summary
protected int __pos

__readOnly	back to summary
protected final boolean __readOnly

Constructor Detail

SequenceContentIterator	back to summary
public SequenceContentIterator(int index, boolean readOnly)

Method Detail

add back to summary

public void add(IonValue element)

Implements java.util.ListIterator.add.

Doc from java.util.ListIterator.add.

Inserts the specified element into the list (optional operation). The element is inserted immediately before the element that would be returned by next, if any, and after the element that would be returned by previous, if any. (If the list contains no elements, the new element becomes the sole element on the list.) The new element is inserted before the implicit cursor: a subsequent call to next would be unaffected, and a subsequent call to previous would return the new element. (This call increases by one the value that would be returned by a call to nextIndex or previousIndex.)

Parameters

element:IonValue: the element to insert

force_position_sync	back to summary
protected final void force_position_sync()

force_position_sync_helper	back to summary
private final void force_position_sync_helper()

hasNext back to summary

public final boolean hasNext()

Implements java.util.ListIterator.hasNext.

Doc from java.util.ListIterator.hasNext.

Returns true if this list iterator has more elements when traversing the list in the forward direction. (In other words, returns true if next would return an element rather than throwing an exception.)

Returns:boolean: true if the list iterator has more elements when traversing the list in the forward direction

hasPrevious back to summary

public final boolean hasPrevious()

Implements java.util.ListIterator.hasPrevious.

Doc from java.util.ListIterator.hasPrevious.

Returns true if this list iterator has more elements when traversing the list in the reverse direction. (In other words, returns true if previous would return an element rather than throwing an exception.)

Returns:boolean: true if the list iterator has more elements when traversing the list in the reverse direction

next back to summary

public IonValue next()

Implements java.util.ListIterator.next.

Doc from java.util.ListIterator.next.

Returns the next element in the list and advances the cursor position. This method may be called repeatedly to iterate through the list, or intermixed with calls to previous to go back and forth. (Note that alternating calls to next and previous will return the same element repeatedly.)

Returns:IonValue: the next element in the list

nextIndex back to summary

public final int nextIndex()

Implements java.util.ListIterator.nextIndex.

Doc from java.util.ListIterator.nextIndex.

Returns the index of the element that would be returned by a subsequent call to next. (Returns list size if the list iterator is at the end of the list.)

Returns:int: the index of the element that would be returned by a subsequent call to next, or list size if the list iterator is at the end of the list

nextOrNull	back to summary
pack-priv IonValueLite nextOrNull() Returns the next element, or null if there are no more elements. This does not call force_position_sync(), so it must only be called from contexts where it is guaranteed that the container has not been mutated since the last position sync.

previous back to summary

public IonValue previous()

Implements java.util.ListIterator.previous.

Doc from java.util.ListIterator.previous.

Returns the previous element in the list and moves the cursor position backwards. This method may be called repeatedly to iterate through the list backwards, or intermixed with calls to next to go back and forth. (Note that alternating calls to next and previous will return the same element repeatedly.)

Returns:IonValue: the previous element in the list

previousIndex back to summary

public final int previousIndex()

Implements java.util.ListIterator.previousIndex.

Doc from java.util.ListIterator.previousIndex.

Returns the index of the element that would be returned by a subsequent call to previous. (Returns -1 if the list iterator is at the beginning of the list.)

Returns:int: the index of the element that would be returned by a subsequent call to previous, or -1 if the list iterator is at the beginning of the list

remove back to summary

public void remove()

Implements java.util.ListIterator.remove.

Sets the container to dirty after calling Iterator#remove() on the encapsulated iterator

set back to summary

public void set(IonValue element)

Implements java.util.ListIterator.set.

Doc from java.util.ListIterator.set.

Replaces the last element returned by next or previous with the specified element (optional operation). This call can be made only if neither remove nor add have been called after the last call to next or previous.

Parameters

element:IonValue: the element with which to replace the last element returned by next or previous

pack-priv abstract Class IonContainerLite

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class IonContainerLite.CloneContext

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

protected Class IonContainerLite.SequenceContentIterator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail