add maxLength argument to Input.showRegion()

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

diff --git a/src/edu/berkeley/sbp/Input.java b/src/edu/berkeley/sbp/Input.java
index 13c45d4..bf0d50d 100644 (file)
--- a/src/edu/berkeley/sbp/Input.java
+++ b/src/edu/berkeley/sbp/Input.java
@@ -22,12 +22,13 @@ public interface Input<Token> {
 
     /**
      *  <b>Optional:</b> <i>If possible</i>, this method will return a
-     *  <60 char long rendering of the input region (for example, if
-     *  the input is a region of characters, it would be those
-     *  characters, possibly with ellipses in the middle to truncate
-     *  the length) -- otherwise, returns null.
+     *  rendering of the input region (for example, if the input is a
+     *  region of characters, it would be those characters) --
+     *  otherwise, returns null.  In any case, the string returned
+     *  will be no more than <tt>maxLength</tt> characters long;
+     *  typically ellipses will be inserted to perform truncation.
      */
-    public abstract String showRegion(Region<Token> r);
+    public abstract String showRegion(Region<Token> r, int maxLength);
 
     /** <font color=purple>a location (position) in the input stream -- <i>between tokens</i></font> */
     public static interface Location<Token> extends Comparable<Location> {