JScanner


1   /*
2    * The contents of this file are subject to the terms of the Common Development
3    * and Distribution License (the License). You may not use this file except in
4    * compliance with the License.
5    *
6    * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7    * or http://www.netbeans.org/cddl.txt.
8    *
9    * When distributing Covered Code, include this CDDL Header Notice in each file
10   * and include the License file at http://www.netbeans.org/cddl.txt.
11   * If applicable, add the following below the CDDL Header, with the fields
12   * enclosed by brackets [] replaced by your own identifying information:
13   * "Portions Copyrighted [year] [name of copyright owner]"
14   *
15   * The Original Software is NetBeans. The Initial Developer of the Original
16   * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17   * Microsystems, Inc. All Rights Reserved.
18   */
19  package org.netbeans.lib.java.parser;
20  
21  /**
22   * Java scanner interface
23   */
24  public interface JScanner {
25      /**
26       * Returns the text of the current lexical token.
27       */
28      String   yytext();
29  
30      /**
31       * Returns the next lexical token.
32       *
33       * @see org.netbeans.lib.java.parser.ParserTokens
34       */
35      int yylex() throws java.io.IOException  ;
36  
37      /**
38       * Returns the hash code of the current lexical token's text.
39       * This value should be identical to that returned from
40       * <code>"yytext().hashCode();"</code>
41       */
42      int yyhash();
43  
44      /**
45       * Returns the current state of the scanner's deprecatedFlag
46       * property.  This property is set true when a deprecated tag
47       * is found in a doc-comment.  This needs to be reset by the
48       * client with resetDeprecatedFlag.
49       */
50      boolean isDeprecated();
51  
52      /**
53       * Reset the scanner's deprecated flag state.
54       */
55      void resetDeprecatedFlag();
56  }
57
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags