1 files changed, 41 insertions, 46 deletions
diff --git a/src/main/java/org/yaml/snakeyaml/scanner/Scanner.java b/src/main/java/org/yaml/snakeyaml/scanner/Scanner.java
index 6fc0d97c..ef9b8d65 100644
--- a/src/main/java/org/yaml/snakeyaml/scanner/Scanner.java
+++ b/src/main/java/org/yaml/snakeyaml/scanner/Scanner.java
@@ -1,65 +1,60 @@
 /**
- * Copyright (c) 2008, http://www.snakeyaml.org
+ * Copyright (c) 2008, SnakeYAML
  *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License. You may obtain a copy of the License at
  *
- *     http://www.apache.org/licenses/LICENSE-2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
  *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
+ * Unless required by applicable law or agreed to in writing, software distributed under the License
+ * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+ * or implied. See the License for the specific language governing permissions and limitations under
+ * the License.
  */
 package org.yaml.snakeyaml.scanner;
 
 import org.yaml.snakeyaml.tokens.Token;
 
 /**
- * This interface represents an input stream of {@link Token Tokens}.
+ * This interface represents an input stream of {@link Token}s.
  * <p>
- * The parser and the scanner form together the 'Parse' step in the loading
- * process (see chapter 3.1 of the <a href="http://yaml.org/spec/1.1/">YAML
- * Specification</a>).
+ * The parser and the scanner form together the 'Parse' step in the loading process (see chapter 3.1
+ * of the <a href="http://yaml.org/spec/1.1/">YAML Specification</a>).
  * </p>
- * 
+ *
  * @see org.yaml.snakeyaml.tokens.Token
  */
 public interface Scanner {
 
-    /**
-     * Check if the next token is one of the given types.
-     * 
-     * @param choices
-     *            token IDs.
-     * @return <code>true</code> if the next token can be assigned to a variable
-     *         of at least one of the given types. Returns <code>false</code> if
-     *         no more tokens are available.
-     * @throws ScannerException
-     *             Thrown in case of malformed input.
-     */
-    boolean checkToken(Token.ID... choices);
+  /**
+   * Check if the next token is one of the given types.
+   *
+   * @param choices token IDs to match with
+   * @return <code>true</code> if the next token is one of the given types. Returns
+   *         <code>false</code> if no more tokens are available.
+   * @throws ScannerException Thrown in case of malformed input.
+   */
+  boolean checkToken(Token.ID... choices);
 
-    /**
-     * Return the next token, but do not delete it from the stream.
-     * 
-     * @return The token that will be returned on the next call to
-     *         {@link #getToken}
-     * @throws ScannerException
-     *             Thrown in case of malformed input.
-     */
-    Token peekToken();
+  /**
+   * Return the next token, but do not delete it from the stream.
+   *
+   * @return The token that will be returned on the next call to {@link #getToken}
+   * @throws ScannerException Thrown in case of malformed input.
+   * @throws IndexOutOfBoundsException if no more token left
+   */
+  Token peekToken();
 
-    /**
-     * Returns the next token.
-     * <p>
-     * The token will be removed from the stream.
-     * </p>
-     * 
-     * @throws ScannerException
-     *             Thrown in case of malformed input.
-     */
-    Token getToken();
+  /**
+   * Returns the next token.
+   * <p>
+   * The token will be removed from the stream. (Every invocation of this method must happen after
+   * calling either {@link #checkToken} or {@link #peekToken()}
+   * </p>
+   *
+   * @return the coming token
+   * @throws ScannerException Thrown in case of malformed input.
+   * @throws IndexOutOfBoundsException if no more token left
+   */
+  Token getToken();
 }