Home » Xerces-J-src.2.9.1 » org.apache.xerces » util » [javadoc | source]
org.apache.xerces.util
public class: SymbolTable [javadoc | source]
java.lang.Object
   org.apache.xerces.util.SymbolTable

Direct Known Subclasses:
    SoftReferenceSymbolTable, ShadowedSymbolTable, SynchronizedSymbolTable

This class is a symbol table implementation that guarantees that strings used as identifiers are unique references. Multiple calls to addSymbol will always return the same string reference.

The symbol table performs the same task as String.intern() with the following differences:

An instance of SymbolTable has two parameters that affect its performance: initial capacity and load factor. The capacity is the number of buckets in the SymbolTable, and the initial capacity is simply the capacity at the time the SymbolTable is created. Note that the SymbolTable is open: in the case of a "hash collision", a single bucket stores multiple entries, which must be searched sequentially. The load factor is a measure of how full the SymbolTable is allowed to get before its capacity is automatically increased. When the number of entries in the SymbolTable exceeds the product of the load factor and the current capacity, the capacity is increased by calling the rehash method.

Generally, the default load factor (.75) offers a good tradeoff between time and space costs. Higher values decrease the space overhead but increase the time cost to look up an entry (which is reflected in most SymbolTable operations, including addSymbol and containsSymbol).

The initial capacity controls a tradeoff between wasted space and the need for rehash operations, which are time-consuming. No rehash operations will ever occur if the initial capacity is greater than the maximum number of entries the Hashtable will contain divided by its load factor. However, setting the initial capacity too high can waste space.

If many entries are to be made into a SymbolTable, creating it with a sufficiently large capacity may allow the entries to be inserted more efficiently than letting it perform automatic rehashing as needed to grow the table.

Nested Class Summary:
protected static final class  SymbolTable.Entry  This class is a symbol table entry. Each entry acts as a node in a linked list. 
Field Summary
protected static final  int TABLE_SIZE    Default table size. 
protected  SymbolTable.Entry[] fBuckets    Buckets. 
protected  int fTableSize    actual table size 
protected transient  int fCount    The total number of entries in the hash table. 
protected  int fThreshold    The table is rehashed when its size exceeds this threshold. (The value of this field is (int)(capacity * loadFactor).) 
protected  float fLoadFactor    The load factor for the SymbolTable. 
Constructor:
 public SymbolTable() 
 public SymbolTable(int initialCapacity) 
 public SymbolTable(int initialCapacity,
    float loadFactor) 
Method from org.apache.xerces.util.SymbolTable Summary:
addSymbol,   addSymbol,   containsSymbol,   containsSymbol,   hash,   hash,   rehash
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.xerces.util.SymbolTable Detail:
 public String addSymbol(String symbol) 
    Adds the specified symbol to the symbol table and returns a reference to the unique symbol. If the symbol already exists, the previous symbol reference is returned instead, in order guarantee that symbol references remain unique.
 public String addSymbol(char[] buffer,
    int offset,
    int length) 
    Adds the specified symbol to the symbol table and returns a reference to the unique symbol. If the symbol already exists, the previous symbol reference is returned instead, in order guarantee that symbol references remain unique.
 public boolean containsSymbol(String symbol) 
    Returns true if the symbol table already contains the specified symbol.
 public boolean containsSymbol(char[] buffer,
    int offset,
    int length) 
    Returns true if the symbol table already contains the specified symbol.
 public int hash(String symbol) 
    Returns a hashcode value for the specified symbol. The value returned by this method must be identical to the value returned by the hash(char[],int,int) method when called with the character array that comprises the symbol string.
 public int hash(char[] buffer,
    int offset,
    int length) 
    Returns a hashcode value for the specified symbol information. The value returned by this method must be identical to the value returned by the hash(String) method when called with the string object created from the symbol information.
 protected  void rehash() 
    Increases the capacity of and internally reorganizes this SymbolTable, in order to accommodate and access its entries more efficiently. This method is called automatically when the number of keys in the SymbolTable exceeds this hashtable's capacity and load factor.