java_cup
Class symbol_set
public class symbol_set
extends java.lang.Object
This class represents a set of symbols and provides a series of
set operations to manipulate them.
Version:
- Scott Hudson
symbol
protected Hashtable | _all - A hash table to hold the set.
|
boolean | add(symbol sym) - Add a single symbol to the set.
|
boolean | add(symbol_set other) - Add (union) in a complete set.
|
Enumeration | all() - Access to all elements of the set.
|
boolean | contains(symbol sym) - Determine if the set contains a particular symbol.
|
boolean | equals(Object other) - Generic equality comparison.
|
boolean | equals(symbol_set other) - Equality comparison.
|
int | hashCode() - Compute a hash code.
|
boolean | is_subset_of(symbol_set other) - Determine if this set is an (improper) subset of another.
|
boolean | is_superset_of(symbol_set other) - Determine if this set is an (improper) superset of another.
|
protected void | not_null(Object obj) - Helper function to test for a null object and throw an exception
if one is found.
|
void | remove(symbol sym) - Remove a single symbol if it is in the set.
|
void | remove(symbol_set other) - Remove (set subtract) a complete set.
|
int | size() - size of the set
|
String | toString() - Convert to a string.
|
_all
protected Hashtable _all
A hash table to hold the set. Symbols are keyed using their name string.
symbol_set
public symbol_set()
Constructor for an empty set.
symbol_set
public symbol_set(symbol_set other)
throws internal_error
Constructor for cloning from another set.
other
- the set we are cloning from.
add
public boolean add(symbol sym)
throws internal_error
Add a single symbol to the set.
sym
- the symbol we are adding.
- true if this changes the set.
add
public boolean add(symbol_set other)
throws internal_error
Add (union) in a complete set.
other
- the set we are adding in.
- true if this changes the set.
all
public Enumeration all()
Access to all elements of the set.
contains
public boolean contains(symbol sym)
Determine if the set contains a particular symbol.
sym
- the symbol we are looking for.
equals
public boolean equals(Object other)
Generic equality comparison.
equals
public boolean equals(symbol_set other)
Equality comparison.
hashCode
public int hashCode()
Compute a hash code.
is_subset_of
public boolean is_subset_of(symbol_set other)
throws internal_error
Determine if this set is an (improper) subset of another.
other
- the set we are testing against.
is_superset_of
public boolean is_superset_of(symbol_set other)
throws internal_error
Determine if this set is an (improper) superset of another.
other
- the set we are are testing against.
not_null
protected void not_null(Object obj)
throws internal_error
Helper function to test for a null object and throw an exception
if one is found.
obj
- the object we are testing.
remove
public void remove(symbol sym)
throws internal_error
Remove a single symbol if it is in the set.
sym
- the symbol we are removing.
remove
public void remove(symbol_set other)
throws internal_error
Remove (set subtract) a complete set.
other
- the set we are removing.
size
public int size()
size of the set
toString
public String toString()
Convert to a string.