cleanups, reorg, and commenting

[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 e02b79f..a9e8981 100644 (file)
--- a/src/edu/berkeley/sbp/Atom.java
+++ b/src/edu/berkeley/sbp/Atom.java
@@ -1,27 +1,23 @@
-// Copyright 2006 all rights reserved; see LICENSE file for BSD-style license
+// (C) 2006-2007 all rights reserved; see LICENSE file for BSD-style license

 
 package edu.berkeley.sbp;
 
 package edu.berkeley.sbp;

-import java.io.*;
-import java.util.*;
-import java.lang.reflect.*;
-import java.lang.ref.*;

 import edu.berkeley.sbp.util.*;
 import edu.berkeley.sbp.util.*;

-import edu.berkeley.sbp.*;
-import edu.berkeley.sbp.*;

 
 /**
 
 /**

- *  <font color=green>an element which matches some set of one-token-long input strings</font>.
+ *  <font color=green>
+ *  an element which matches some set of one-token-long input strings
+ *  </font>.

  *
  *  <p>
  *
  *  <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.
+ *  This class is a topology over itself (yes, this is impredicative).
+ *  This means that you can call Atom.union(Atom) and get back an Atom.
+ *  If you are interested in the topology of <i>tokens</i> which this
+ *  Atom can match, use the <tt>getTokenTopology()</tt> method.

  *  </p>
  */
  *  </p>
  */

-public abstract class Atom<Token> extends Element implements Topology<Atom<Token>> {
+public abstract class Atom<Token>
+    extends Element
+    implements Topology<Atom<Token>> {

 
     /** the set (topology) of tokens that can match this element */
     public abstract Topology<Token>  getTokenTopology();
 
     /** the set (topology) of tokens that can match this element */
     public abstract Topology<Token>  getTokenTopology();