1 files changed, 80 insertions, 67 deletions
diff --git a/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/CharStream.java b/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/CharStream.java
index 3445800c..de96c43f 100644
--- a/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/CharStream.java
+++ b/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/CharStream.java
@@ -34,81 +34,94 @@ package org.apache.velocity.runtime.parser;
  * operation.
  */
 
-public interface CharStream {
+public interface CharStream
+{
+    /**
+    * Returns the next character from the selected input.  The method
+    * of selecting the input is the responsibility of the class
+    * implementing this interface.  Can throw any java.io.IOException.
+    * @return read char
+    * @throws java.io.IOException
+    */
+    char readChar() throws java.io.IOException;
 
-  /**
-   * Returns the next character from the selected input.  The method
-   * of selecting the input is the responsibility of the class
-   * implementing this interface.  Can throw any java.io.IOException.
-   */
-  char readChar() throws java.io.IOException;
+    /**
+    * Returns the column number of the last character for current token (being
+    * matched after the last call to BeginTOken).
+    * @return ending column number
+    */
+    int getEndColumn();
 
-  /**
-   * Returns the column number of the last character for current token (being
-   * matched after the last call to BeginTOken).
-   */
-  int getEndColumn();
+    /**
+    * Returns the line number of the last character for current token (being
+    * matched after the last call to BeginTOken).
+    * @return ending line number
+    */
+    int getEndLine();
 
-  /**
-   * Returns the line number of the last character for current token (being
-   * matched after the last call to BeginTOken).
-   */
-  int getEndLine();
+    /**
+    * Returns the column number of the first character for current token (being
+    * matched after the last call to BeginTOken).
+    * @return starting column number
+    */
+    int getBeginColumn();
 
-  /**
-   * Returns the column number of the first character for current token (being
-   * matched after the last call to BeginTOken).
-   */
-  int getBeginColumn();
+    /**
+    * Returns the line number of the first character for current token (being
+    * matched after the last call to BeginTOken).
+    * @return starting line number
+    */
+    int getBeginLine();
 
-  /**
-   * Returns the line number of the first character for current token (being
-   * matched after the last call to BeginTOken).
-   */
-  int getBeginLine();
+    /**
+    * Backs up the input stream by amount steps. Lexer calls this method if it
+    * had already read some characters, but could not use them to match a
+    * (longer) token. So, they will be used again as the prefix of the next
+    * token and it is the implemetation's responsibility to do this right.
+    * @param amount
+    */
+    void backup(int amount);
 
-  /**
-   * Backs up the input stream by amount steps. Lexer calls this method if it
-   * had already read some characters, but could not use them to match a
-   * (longer) token. So, they will be used again as the prefix of the next
-   * token and it is the implemetation's responsibility to do this right.
-   */
-  void backup(int amount);
+    /**
+    * Returns the next character that marks the beginning of the next token.
+    * All characters must remain in the buffer between two successive calls
+    * to this method to implement backup correctly.
+    * @return next token start char
+    * @throws java.io.IOException
+    */
+    char BeginToken() throws java.io.IOException;
 
-  /**
-   * Returns the next character that marks the beginning of the next token.
-   * All characters must remain in the buffer between two successive calls
-   * to this method to implement backup correctly.
-   */
-  char BeginToken() throws java.io.IOException;
+    /**
+    * Returns a string made up of characters from the marked token beginning
+    * to the current buffer position. Implementations have the choice of returning
+    * anything that they want to. For example, for efficiency, one might decide
+    * to just return null, which is a valid implementation.
+    * @return token image
+    */
+    String GetImage();
 
-  /**
-   * Returns a string made up of characters from the marked token beginning
-   * to the current buffer position. Implementations have the choice of returning
-   * anything that they want to. For example, for efficiency, one might decide
-   * to just return null, which is a valid implementation.
-   */
-  String GetImage();
+    /**
+    * <p>Returns an array of characters that make up the suffix of length 'len' for
+    * the currently matched token. This is used to build up the matched string
+    * for use in actions in the case of MORE. A simple and inefficient
+    * implementation of this is as follows :</p>
+    * <pre><code>
+    *   {
+    *      String t = GetImage();
+    *      return t.substring(t.length() - len, t.length()).toCharArray();
+    *   }
+    *   </code></pre>
+    *   @param len suffix len
+    *   @return suffix
+    */
+    char[] GetSuffix(int len);
 
-  /**
-   * Returns an array of characters that make up the suffix of length 'len' for
-   * the currently matched token. This is used to build up the matched string
-   * for use in actions in the case of MORE. A simple and inefficient
-   * implementation of this is as follows :
-   *
-   *   {
-   *      String t = GetImage();
-   *      return t.substring(t.length() - len, t.length()).toCharArray();
-   *   }
-   */
-  char[] GetSuffix(int len);
-
-  /**
-   * The lexer calls this function to indicate that it is done with the stream
-   * and hence implementations can free any resources held by this class.
-   * Again, the body of this function can be just empty and it will not
-   * affect the lexer's operation.
-   */
-  void Done();
+    /**
+    * The lexer calls this function to indicate that it is done with the stream
+    * and hence implementations can free any resources held by this class.
+    * Again, the body of this function can be just empty and it will not
+    * affect the lexer's operation.
+    */
+    void Done();
 
 }