make ANSI.clreol()

[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 0a8ad12..e02b79f 100644 (file)
--- a/src/edu/berkeley/sbp/Atom.java
+++ b/src/edu/berkeley/sbp/Atom.java
@@ -1,3 +1,5 @@
+// Copyright 2006 all rights reserved; see LICENSE file for BSD-style license
+
 package edu.berkeley.sbp;
 import java.io.*;
 import java.util.*;
@@ -10,16 +12,22 @@ import edu.berkeley.sbp.*;
 /**
  *  <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.
+ *  <p>
+ *  This class is a topology over itself (yes, that's sort of <a
+ *  href=http://en.wikipedia.org/wiki/Frege>Frege'd</a> up) so that
+ *  Atoms can be intersected and unioned with each other to result in
+ *  other Atom<Token>'s (rather than raw Topology<Token>'s, which are
+ *  not Elements).  If you want the latter, use the getTokenTopology()
+ *  method.
+ *  </p>
  */
-public abstract class Atom<T> extends Element implements Topology<Atom<T>> {
+public abstract class Atom<Token> extends Element implements Topology<Atom<Token>> {
 
     /** the set (topology) of tokens that can match this element */
-    public abstract Topology<T>  getTokenTopology();
+    public abstract Topology<Token>  getTokenTopology();
+
+    StringBuffer toString(StringBuffer sb) { sb.append(this); return sb; }
 
-    public abstract StringBuffer toString(StringBuffer sb);
 }
 
+