Top Methods
com.amazon.ion.impl

pack-priv Interface SystemValueIterator

extends Iterator<IonValue>, Closeable
Imports
com.amazon.ion.IonCatalog, .IonSystem, .IonValue, .SymbolTable, com.amazon.ion.impl.IonBinary.BufferManager, java.io.Closeable, .IOException, java.util.Iterator

Method Summary

Modifier and TypeMethod and Description
public void
close()

Redeclares java.io.Closeable.close.

Closes this stream and releases any system resources associated with it.

public boolean
currentIsHidden()

public IonBinary.BufferManager
getBuffer()

public IonCatalog
getCatalog()

public SymbolTable

Returns:

not null.
getLocalSymbolTable()

Gets the current symtab if its local, otherwise creates a local symtab and makes it current.

public SymbolTable

Returns:

may be null.
getSymbolTable()

Returns the current symtab, either system or local.

public IonSystem
getSystem()

SystemReader

public boolean
hasNext()

Redeclares java.util.Iterator.hasNext.

Iterator<ionvalue>

public IonValue
next()

Redeclares java.util.Iterator.next.

Returns the next element in the iteration.

public void
remove()

Redeclares as abstract: java.util.Iterator.remove.

Removes from the underlying collection the last element returned by this iterator (optional operation).

public void
resetBuffer()

Inherited from java.util.Iterator:
forEachRemaining

Method Detail

closeback to summary
public void close() throws IOException

Redeclares java.io.Closeable.close.

Doc from java.io.Closeable.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.

As noted in AutoCloseable#close(), cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the Closeable as closed, prior to throwing the IOException.

Exceptions
IOException:
if an I/O error occurs
currentIsHiddenback to summary
public boolean currentIsHidden()
getBufferback to summary
public IonBinary.BufferManager getBuffer()
getCatalogback to summary
public IonCatalog getCatalog()
getLocalSymbolTableback to summary
public SymbolTable getLocalSymbolTable()

Gets the current symtab if its local, otherwise creates a local symtab and makes it current.

Returns:SymbolTable

not null.

getSymbolTableback to summary
public SymbolTable getSymbolTable()

Returns the current symtab, either system or local.

Returns:SymbolTable

may be null.

getSystemback to summary
public IonSystem getSystem()

SystemReader

hasNextback to summary
public boolean hasNext()

Redeclares java.util.Iterator.hasNext.

Iterator

Returns:boolean

Doc from java.util.Iterator.hasNext.

true if the iteration has more elements

nextback to summary
public IonValue next()

Redeclares java.util.Iterator.next.

Doc from java.util.Iterator.next.

Returns the next element in the iteration.

Returns:IonValue

the next element in the iteration

removeback to summary
public void remove()

Redeclares as abstract: java.util.Iterator.remove.

Doc from java.util.Iterator.remove.

Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to next.

The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method, unless an overriding class has specified a concurrent modification policy.

The behavior of an iterator is unspecified if this method is called after a call to the forEachRemaining method.

resetBufferback to summary
public void resetBuffer()