Modifier and Type	Class and Description
private class	SubstituteSymbolTable.SymbolIterator

Modifier and Type	Field and Description
private final int	myMaxId
private final String	myName
private final SymbolTable	myOriginalSymTab This is the original symbol table that is being substituted.
private final int	myVersion

Access	Constructor and Description
pack-priv	SubstituteSymbolTable(String name, int version, int maxId)
pack-priv	SubstituteSymbolTable(SymbolTable original, int version, int maxId)

Method Summary

Modifier and Type	Method and Description
public SymbolToken	find(String the symbol text to find. text) Implements com.amazon.ion.SymbolTable.find. Finds a symbol already interned by this table.
public String	findKnownSymbol(int the requested symbol ID. id) Implements com.amazon.ion.SymbolTable.findKnownSymbol. Gets the interned text for a symbol ID.
public int	findSymbol(String must not be null or empty. text) Implements com.amazon.ion.SymbolTable.findSymbol. Gets the symbol ID associated with a given symbol name.
public int	getImportedMaxId() Implements com.amazon.ion.SymbolTable.getImportedMaxId. Gets the highest symbol id reserved by this table's imports (including system symbols).
public SymbolTable[]	getImportedTables() Implements com.amazon.ion.SymbolTable.getImportedTables. Gets the sequence of shared symbol tables imported by this (local) symbol table.
public String	getIonVersionId() Implements com.amazon.ion.SymbolTable.getIonVersionId. Gets the identifier for the Ion version (and thus the system symbol table) used by this table.
public int	getMaxId() Implements com.amazon.ion.SymbolTable.getMaxId. Gets the highest symbol id reserved by this table.
public String	getName() Implements com.amazon.ion.SymbolTable.getName. Gets the unique name of this symbol table.
public SymbolTable	getSystemSymbolTable() Implements com.amazon.ion.SymbolTable.getSystemSymbolTable. Gets the system symbol table being used by this local table.
public int	getVersion() Implements com.amazon.ion.SymbolTable.getVersion. Gets the version of this symbol table.
public SymbolToken	intern(String the symbol text to intern. text) Implements com.amazon.ion.SymbolTable.intern. Adds a new symbol to this table, or finds an existing definition of it.
public boolean	isLocalTable() Implements com.amazon.ion.SymbolTable.isLocalTable. Determines whether this symbol table is local, and therefore unnamed and unversioned.
public boolean	isReadOnly() Implements com.amazon.ion.SymbolTable.isReadOnly. Determines whether this symbol table can have symbols added to it.
public boolean	isSharedTable() Implements com.amazon.ion.SymbolTable.isSharedTable. Determines whether this symbol table is shared, and therefore named, versioned, and read-only.
public boolean	isSubstitute() Implements com.amazon.ion.SymbolTable.isSubstitute. Determines whether this instance is substituting for an imported shared table for which no exact match was found in the catalog.
public boolean	isSystemTable() Implements com.amazon.ion.SymbolTable.isSystemTable. Determines whether this symbol table is a system symbol table, and therefore shared, named, versioned, and read-only.
public Iterator<String>	iterateDeclaredSymbolNames() Implements com.amazon.ion.SymbolTable.iterateDeclaredSymbolNames. Creates an iterator that will return all non-imported symbol names, in order of their symbol IDs.
public void	makeReadOnly() Implements com.amazon.ion.SymbolTable.makeReadOnly. Prevents this symbol table from accepting any more new symbols.
public void	writeTo(IonWriter must not be null. writer) Implements com.amazon.ion.SymbolTable.writeTo. Writes an Ion representation of this symbol table.

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

Field Detail

myMaxId	back to summary
private final int myMaxId

myName	back to summary
private final String myName

myOriginalSymTab	back to summary
private final SymbolTable myOriginalSymTab This is the original symbol table that is being substituted. Either null or a non-system shared table.

myVersion	back to summary
private final int myVersion

Constructor Detail

SubstituteSymbolTable	back to summary
pack-priv SubstituteSymbolTable(String name, int version, int maxId)

SubstituteSymbolTable	back to summary
pack-priv SubstituteSymbolTable(SymbolTable original, int version, int maxId)

Method Detail

find back to summary

find	back to summary
public SymbolToken find(String text) Implements com.amazon.ion.SymbolTable.find. Doc from com.amazon.ion.SymbolTable.find. Finds a symbol already interned by this table. This method will not necessarily return the same instance given the same input. Parameters text:String the symbol text to find. Returns:SymbolToken the interned symbol, with both text and SID defined; or `null` if it's not already interned.

public SymbolToken find(String text)

Implements com.amazon.ion.SymbolTable.find.

Doc from com.amazon.ion.SymbolTable.find.

Finds a symbol already interned by this table.

This method will not necessarily return the same instance given the same input.

Parameters

text:String: the symbol text to find.

Returns:SymbolToken

the interned symbol, with both text and SID defined; or null if it's not already interned.

findKnownSymbol back to summary

findKnownSymbol	back to summary
public String findKnownSymbol(int id) Implements com.amazon.ion.SymbolTable.findKnownSymbol. Doc from com.amazon.ion.SymbolTable.findKnownSymbol. Gets the interned text for a symbol ID. Parameters id:int the requested symbol ID. Returns:String the interned text associated with the symbol ID, or `null` if the text is not known.

public String findKnownSymbol(int id)

Implements com.amazon.ion.SymbolTable.findKnownSymbol.

Doc from com.amazon.ion.SymbolTable.findKnownSymbol.

Gets the interned text for a symbol ID.

Parameters

id:int: the requested symbol ID.

Returns:String

the interned text associated with the symbol ID, or null if the text is not known.

findSymbol back to summary

findSymbol	back to summary
public int findSymbol(String text) Implements com.amazon.ion.SymbolTable.findSymbol. Doc from com.amazon.ion.SymbolTable.findSymbol. Gets the symbol ID associated with a given symbol name. Parameters text:String must not be null or empty. Returns:int the id of the requested symbol, or `UNKNOWN_SYMBOL_ID` if it's not defined.

public int findSymbol(String text)

Implements com.amazon.ion.SymbolTable.findSymbol.

Doc from com.amazon.ion.SymbolTable.findSymbol.

Gets the symbol ID associated with a given symbol name.

Parameters

text:String: must not be null or empty.

Returns:int

the id of the requested symbol, or UNKNOWN_SYMBOL_ID if it's not defined.

getImportedMaxId	back to summary
public int getImportedMaxId() Implements com.amazon.ion.SymbolTable.getImportedMaxId. Doc from com.amazon.ion.SymbolTable.getImportedMaxId. Gets the highest symbol id reserved by this table's imports (including system symbols). Any id higher than this value is a local symbol declared by this table. This value is zero for shared symbol tables, since they do not utilize imports.

getImportedMaxId

back to summary

public int getImportedMaxId()

Implements com.amazon.ion.SymbolTable.getImportedMaxId.

Doc from com.amazon.ion.SymbolTable.getImportedMaxId.

Gets the highest symbol id reserved by this table's imports (including system symbols). Any id higher than this value is a local symbol declared by this table. This value is zero for shared symbol tables, since they do not utilize imports.

getImportedTables back to summary

getImportedTables	back to summary
public SymbolTable[] getImportedTables() Implements com.amazon.ion.SymbolTable.getImportedTables. Doc from com.amazon.ion.SymbolTable.getImportedTables. Gets the sequence of shared symbol tables imported by this (local) symbol table. The result does not include a system table. If this local table imported a shared table for which the relevant `IonCatalog` has the same name but different version and/or max_id, then that entry will be a substitute table with the correct version and max_id, wrapping the original shared symbol table that was found. If this local table imported a shared table for which the relevant `IonCatalog` has no entry with the same name, but the import declaration has a max_id available, then that entry will be a substitute table with max_id undefined symbols. Returns:SymbolTable[] `null` if this is a shared or system table, otherwise a non-null but potentially zero-length array of shared tables (but no system table).

public SymbolTable[] getImportedTables()

Implements com.amazon.ion.SymbolTable.getImportedTables.

Doc from com.amazon.ion.SymbolTable.getImportedTables.

Gets the sequence of shared symbol tables imported by this (local) symbol table. The result does not include a system table.

If this local table imported a shared table for which the relevant IonCatalog has the same name but different version and/or max_id, then that entry will be a substitute table with the correct version and max_id, wrapping the original shared symbol table that was found.

If this local table imported a shared table for which the relevant IonCatalog has no entry with the same name, but the import declaration has a max_id available, then that entry will be a substitute table with max_id undefined symbols.

Returns:SymbolTable[]: null if this is a shared or system table, otherwise a non-null but potentially zero-length array of shared tables (but no system table).

getIonVersionId back to summary

getIonVersionId	back to summary
public String getIonVersionId() Implements com.amazon.ion.SymbolTable.getIonVersionId. Doc from com.amazon.ion.SymbolTable.getIonVersionId. Gets the identifier for the Ion version (and thus the system symbol table) used by this table. The version identifier is a string of the form `"$ion_X_Y"`. Returns:String the version identifier; or `null` for non-system shared tables.

public String getIonVersionId()

Implements com.amazon.ion.SymbolTable.getIonVersionId.

Doc from com.amazon.ion.SymbolTable.getIonVersionId.

Gets the identifier for the Ion version (and thus the system symbol table) used by this table. The version identifier is a string of the form "$ion_X_Y".

Returns:String: the version identifier; or null for non-system shared tables.

getMaxId back to summary

getMaxId	back to summary
public int getMaxId() Implements com.amazon.ion.SymbolTable.getMaxId. Doc from com.amazon.ion.SymbolTable.getMaxId. Gets the highest symbol id reserved by this table. Returns:int the largest integer such that `findKnownSymbol(int)` could return a non-`null` result. Note that there is no promise that it will return a name, only that any larger id will not have a name defined.

public int getMaxId()

Implements com.amazon.ion.SymbolTable.getMaxId.

Doc from com.amazon.ion.SymbolTable.getMaxId.

Gets the highest symbol id reserved by this table.

Returns:int: the largest integer such that findKnownSymbol(int) could return a non-null result. Note that there is no promise that it will return a name, only that any larger id will not have a name defined.

getName back to summary

getName	back to summary
public String getName() Implements com.amazon.ion.SymbolTable.getName. Doc from com.amazon.ion.SymbolTable.getName. Gets the unique name of this symbol table. Returns:String the unique name, or `null` if `isLocalTable()`.

public String getName()

Implements com.amazon.ion.SymbolTable.getName.

Doc from com.amazon.ion.SymbolTable.getName.

Gets the unique name of this symbol table.

Returns:String: the unique name, or null if isLocalTable().

getSystemSymbolTable back to summary

getSystemSymbolTable	back to summary
public SymbolTable getSystemSymbolTable() Implements com.amazon.ion.SymbolTable.getSystemSymbolTable. Doc from com.amazon.ion.SymbolTable.getSystemSymbolTable. Gets the system symbol table being used by this local table. If `isSystemTable()` then this method returns `this`. Otherwise, if `isSharedTable()` then this method returns `null`. Returns:SymbolTable not `null`, except for non-system shared tables.

public SymbolTable getSystemSymbolTable()

Implements com.amazon.ion.SymbolTable.getSystemSymbolTable.

Doc from com.amazon.ion.SymbolTable.getSystemSymbolTable.

Gets the system symbol table being used by this local table.

If isSystemTable() then this method returns this. Otherwise, if isSharedTable() then this method returns null.

Returns:SymbolTable: not null, except for non-system shared tables.

getVersion back to summary

getVersion	back to summary
public int getVersion() Implements com.amazon.ion.SymbolTable.getVersion. Doc from com.amazon.ion.SymbolTable.getVersion. Gets the version of this symbol table. Returns:int at least one, or zero if `isLocalTable()`.

public int getVersion()

Implements com.amazon.ion.SymbolTable.getVersion.

Doc from com.amazon.ion.SymbolTable.getVersion.

Gets the version of this symbol table.

Returns:int: at least one, or zero if isLocalTable().

intern back to summary

intern	back to summary
public SymbolToken intern(String text) Implements com.amazon.ion.SymbolTable.intern. Doc from com.amazon.ion.SymbolTable.intern. Adds a new symbol to this table, or finds an existing definition of it. The resulting `SymbolToken` has the same String instance that was first interned. In order to reduce memory footprint, callers should generally replace their copy of the text with the string in the result. This method will not necessarily return the same instance given the same input. Parameters text:String the symbol text to intern. Returns:SymbolToken the interned symbol, with both text and SID defined; not null.

public SymbolToken intern(String text)

Implements com.amazon.ion.SymbolTable.intern.

Doc from com.amazon.ion.SymbolTable.intern.

Adds a new symbol to this table, or finds an existing definition of it.

The resulting SymbolToken has the same String instance that was first interned. In order to reduce memory footprint, callers should generally replace their copy of the text with the string in the result.

This method will not necessarily return the same instance given the same input.

Parameters

text:String: the symbol text to intern.

Returns:SymbolToken

the interned symbol, with both text and SID defined; not null.

isLocalTable back to summary

isLocalTable	back to summary
public boolean isLocalTable() Implements com.amazon.ion.SymbolTable.isLocalTable. Doc from com.amazon.ion.SymbolTable.isLocalTable. Determines whether this symbol table is local, and therefore unnamed and unversioned. If this method returns `true`, then both `isSharedTable()` and `isSystemTable()` will return `false`.

public boolean isLocalTable()

Implements com.amazon.ion.SymbolTable.isLocalTable.

Doc from com.amazon.ion.SymbolTable.isLocalTable.

Determines whether this symbol table is local, and therefore unnamed and unversioned.

If this method returns true, then both isSharedTable() and isSystemTable() will return false.

isReadOnly	back to summary
public boolean isReadOnly() Implements com.amazon.ion.SymbolTable.isReadOnly. Doc from com.amazon.ion.SymbolTable.isReadOnly. Determines whether this symbol table can have symbols added to it. Shared symtabs are always read-only. Local symtabs can also be made read-only on demand, which enables some optimizations when writing data but will cause failures if new symbols are encountered. Returns:boolean true if this table is read-only, false if symbols may be added.

isReadOnly

back to summary

public boolean isReadOnly()

Implements com.amazon.ion.SymbolTable.isReadOnly.

Doc from com.amazon.ion.SymbolTable.isReadOnly.

Determines whether this symbol table can have symbols added to it. Shared symtabs are always read-only. Local symtabs can also be made read-only on demand, which enables some optimizations when writing data but will cause failures if new symbols are encountered.

Returns:boolean: true if this table is read-only, false if symbols may be added.

isSharedTable back to summary

isSharedTable	back to summary
public boolean isSharedTable() Implements com.amazon.ion.SymbolTable.isSharedTable. Doc from com.amazon.ion.SymbolTable.isSharedTable. Determines whether this symbol table is shared, and therefore named, versioned, and read-only. If this method returns `true`, then `isLocalTable()` will return `false`.

public boolean isSharedTable()

Implements com.amazon.ion.SymbolTable.isSharedTable.

Doc from com.amazon.ion.SymbolTable.isSharedTable.

Determines whether this symbol table is shared, and therefore named, versioned, and read-only.

If this method returns true, then isLocalTable() will return false.

isSubstitute	back to summary
public boolean isSubstitute() Implements com.amazon.ion.SymbolTable.isSubstitute. Doc from com.amazon.ion.SymbolTable.isSubstitute. Determines whether this instance is substituting for an imported shared table for which no exact match was found in the catalog. Such tables are not authoritative and may not even have any symbol text at all (as is the case when no version of an imported table is found). Substitute tables are always shared, non-system tables. This implementation always returns true.

isSubstitute

back to summary

public boolean isSubstitute()

Implements com.amazon.ion.SymbolTable.isSubstitute.

Doc from com.amazon.ion.SymbolTable.isSubstitute.

Determines whether this instance is substituting for an imported shared table for which no exact match was found in the catalog. Such tables are not authoritative and may not even have any symbol text at all (as is the case when no version of an imported table is found).

Substitute tables are always shared, non-system tables.

This implementation always returns true.

isSystemTable back to summary

isSystemTable	back to summary
public boolean isSystemTable() Implements com.amazon.ion.SymbolTable.isSystemTable. Doc from com.amazon.ion.SymbolTable.isSystemTable. Determines whether this symbol table is a system symbol table, and therefore shared, named, versioned, and read-only. If this method returns `true`, then `isLocalTable()` will return `false` and `isSharedTable()` will return `true`.

public boolean isSystemTable()

Implements com.amazon.ion.SymbolTable.isSystemTable.

Doc from com.amazon.ion.SymbolTable.isSystemTable.

Determines whether this symbol table is a system symbol table, and therefore shared, named, versioned, and read-only.

If this method returns true, then isLocalTable() will return false and isSharedTable() will return true.

iterateDeclaredSymbolNames back to summary

iterateDeclaredSymbolNames	back to summary
public Iterator<String> iterateDeclaredSymbolNames() Implements com.amazon.ion.SymbolTable.iterateDeclaredSymbolNames. Doc from com.amazon.ion.SymbolTable.iterateDeclaredSymbolNames. Creates an iterator that will return all non-imported symbol names, in order of their symbol IDs. The iterator will return `null` where there is an undefined sid. The first string returned by the iterator has a symbol ID that is one more than `getImportedMaxId()`, and the last string has symbol ID equals to `getMaxId()`. Returns:Iterator<String> a new iterator. Annotations @SuppressWarnings:unchecked

public Iterator<String> iterateDeclaredSymbolNames()

Implements com.amazon.ion.SymbolTable.iterateDeclaredSymbolNames.

Doc from com.amazon.ion.SymbolTable.iterateDeclaredSymbolNames.

Creates an iterator that will return all non-imported symbol names, in order of their symbol IDs. The iterator will return null where there is an undefined sid.

The first string returned by the iterator has a symbol ID that is one more than getImportedMaxId(), and the last string has symbol ID equals to getMaxId().

Returns:Iterator<String>

a new iterator.

Annotations

@SuppressWarnings:unchecked

makeReadOnly	back to summary
public void makeReadOnly() Implements com.amazon.ion.SymbolTable.makeReadOnly. Doc from com.amazon.ion.SymbolTable.makeReadOnly. Prevents this symbol table from accepting any more new symbols. Shared symtabs are always read-only. Making a local symtab read-only enables some optimizations when writing data, but will cause failures if new symbols are encountered.

makeReadOnly

back to summary

public void makeReadOnly()

Implements com.amazon.ion.SymbolTable.makeReadOnly.

Doc from com.amazon.ion.SymbolTable.makeReadOnly.

Prevents this symbol table from accepting any more new symbols. Shared symtabs are always read-only. Making a local symtab read-only enables some optimizations when writing data, but will cause failures if new symbols are encountered.

writeTo	back to summary
public void writeTo(IonWriter writer) throws IOException Implements com.amazon.ion.SymbolTable.writeTo. Doc from com.amazon.ion.SymbolTable.writeTo. Writes an Ion representation of this symbol table. Parameters writer:IonWriter must not be null. Exceptions IOException: if thrown by the writer.

writeTo

back to summary

public void writeTo(IonWriter writer) throws IOException

Implements com.amazon.ion.SymbolTable.writeTo.

Doc from com.amazon.ion.SymbolTable.writeTo.

Writes an Ion representation of this symbol table.

Parameters

writer:IonWriter: must not be null.

Exceptions

IOException:: if thrown by the writer.

com.amazon.ion.impl back to summary

private final Class SubstituteSymbolTable.SymbolIterator

Class Inheritance

extends Object
implements Iterator<String>

java.lang.Object
com.amazon.ion.impl.SubstituteSymbolTable.SymbolIterator

All Implemented Interfaces

java.util.Iterator

Field Summary

Modifier and Type	Field and Description
private int	myIndex
private Iterator<String>	myOriginalIterator

Constructor Summary

Access	Constructor and Description
pack-priv	SymbolIterator(Iterator<String> originalIterator)

Method Summary

Modifier and Type	Method and Description
public boolean	hasNext() Implements java.util.Iterator.hasNext. Returns `true` if the iteration has more elements.
public String	next() Implements java.util.Iterator.next. Returns the next element in the iteration.
public void	remove() Overrides default java.util.Iterator.remove. Removes from the underlying collection the last element returned by this iterator (optional operation).

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

Field Detail

myIndex	back to summary
private int myIndex

myOriginalIterator	back to summary
private Iterator<String> myOriginalIterator

Constructor Detail

SymbolIterator	back to summary
pack-priv SymbolIterator(Iterator<String> originalIterator)

Method Detail

hasNext back to summary

hasNext	back to summary
public boolean hasNext() Implements java.util.Iterator.hasNext. Doc from java.util.Iterator.hasNext. Returns `true` if the iteration has more elements. (In other words, returns `true` if `next` would return an element rather than throwing an exception.) Returns:boolean `true` if the iteration has more elements

public boolean hasNext()

Implements java.util.Iterator.hasNext.

Doc from java.util.Iterator.hasNext.

Returns true if the iteration has more elements. (In other words, returns true if next would return an element rather than throwing an exception.)

Returns:boolean: true if the iteration has more elements

next	back to summary
public String next() Implements java.util.Iterator.next. Doc from java.util.Iterator.next. Returns the next element in the iteration. Returns:String the next element in the iteration

back to summary

public String next()

Implements java.util.Iterator.next.

Doc from java.util.Iterator.next.

Returns the next element in the iteration.

Returns:String: the next element in the iteration

remove back to summary

remove	back to summary
public void remove() Overrides default 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.

public void remove()

Overrides default 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.

pack-priv final Class SubstituteSymbolTable

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class SubstituteSymbolTable.SymbolIterator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail