checkpoint

[sbp.git] / src / edu / berkeley / sbp / Atom.java

diff --git a/src/edu/berkeley/sbp/Atom.java b/src/edu/berkeley/sbp/Atom.java
index b9832b2..0a8ad12 100644 (file)
--- a/src/edu/berkeley/sbp/Atom.java
+++ b/src/edu/berkeley/sbp/Atom.java
@@ -7,26 +7,19 @@ import edu.berkeley.sbp.util.*;
 import edu.berkeley.sbp.*;
 import edu.berkeley.sbp.*;
 
-/** <font color=green>an element which matches exactly one input token</font> */
-public abstract class Atom<T> extends Element implements Topology<T> {
+/**
+ *  <font color=green>an element which matches some set of one-token-long input strings</font>.
+ *
+ *  This class is a topology over itself so that Atoms can be
+ *  intersected and unioned with each other to result in other
+ *  Atom<T>'s (rather than raw Topology<T>'s, which are not Elements).
+ *  If you want the latter, use the getTokenTopology() method.
+ */
+public abstract class Atom<T> extends Element implements Topology<Atom<T>> {
 
-    protected abstract Topology<T> top();
-    public    abstract String       toString();
-    public             StringBuffer toString(StringBuffer sb) { sb.append(this); return sb; }
-
-    // Topology Thunks //////////////////////////////////////////////////////////////////////////////
-
-    public Topology<T>       unwrap()                   { return top().unwrap(); }
-    public Topology<T>       empty()                    { return top().empty(); }
-    public boolean           contains(T v)              { return top().contains(v); }
-    public Topology<T>       intersect(Topology<T> t)   { return top().intersect(t); }
-    public Topology<T>       minus(Topology<T> t)       { return top().minus(t); }
-    public Topology<T>       union(Topology<T> t)       { return top().union(t); }
-    public Topology<T>       complement()               { return top().complement(); }
-    public boolean           disjoint(Topology<T> t)    { return top().disjoint(t); }
-    public boolean           containsAll(Topology<T> t) { return top().containsAll(t); }
-    public int               hashCode()                 { return top().hashCode(); }
-    public boolean           equals(Object o)           { return o != null && o instanceof Atom && ((Atom)o).top().equals(top()); }
+    /** the set (topology) of tokens that can match this element */
+    public abstract Topology<T>  getTokenTopology();
 
+    public abstract StringBuffer toString(StringBuffer sb);
 }