checkpoint
[sbp.git] / src / edu / berkeley / sbp / Input.java
index d8374cd..a2c9baa 100644 (file)
@@ -6,11 +6,14 @@ import java.lang.ref.*;
 import edu.berkeley.sbp.*;
 import edu.berkeley.sbp.util.*;
 
-/** a token of input -- note that this represents an <i>actual input token</i> rather than an <tt>Element</tt> which <i>matches</i> a token */
-public interface Input<Tok> {
+/** a stream of tokens to be parsed */
+public interface Input<Token> {
 
-    public Tok next(int numstates, int resets, int waits) throws IOException;
-    public abstract Location getLocation();
+    /** returns the token just beyond the current location and advances beyond it */
+    public Token    next(int numstates, int resets, int waits) throws IOException;
+
+    /** returns the location the input stream is currently at */
+    public Location getLocation();
 
     /** a location *between tokens* in the input stream */
     public static interface Location {