/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

/*

 * Copyright (C) 2004-2011

 *

 * Permission is hereby granted, free of charge, to any person obtaining a copy

 * of this software and associated documentation files (the "Software"), to deal

 * in the Software without restriction, including without limitation the rights

 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

 * copies of the Software, and to permit persons to whom the Software is

 * furnished to do so, subject to the following conditions:

 *

 * The above copyright notice and this permission notice shall be included in

 * all copies or substantial portions of the Software.

 *

 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN

 * THE SOFTWARE.

 */

/* Generated By:JavaCC: Do not edit this line. Token.java Version 5.0 */

/* JavaCCOptions:TOKEN_EXTENDS=,KEEP_LINE_COL=null,SUPPORT_CLASS_VISIBILITY_PUBLIC=true */

package com.sun.xml.internal.rngom.parse.compact;

/**

 * Describes the input token stream.

 */

public class Token implements java.io.Serializable {

  /**

   * The version identifier for this Serializable class.

   * Increment only if the <i>serialized</i> form of the

   * class changes.

   */

  private static final long serialVersionUID = 1L;

  /**

   * An integer that describes the kind of this token.  This numbering

   * system is determined by JavaCCParser, and a table of these numbers is

   * stored in the file ...Constants.java.

   */

  public int kind;

  /** The line number of the first character of this Token. */

  public int beginLine;

  /** The column number of the first character of this Token. */

  public int beginColumn;

  /** The line number of the last character of this Token. */

  public int endLine;

  /** The column number of the last character of this Token. */

  public int endColumn;

  /**

   * The string image of the token.

   */

  public String image;

  /**

   * A reference to the next regular (non-special) token from the input

   * stream.  If this is the last token from the input stream, or if the

   * token manager has not read tokens beyond this one, this field is

   * set to null.  This is true only if this token is also a regular

   * token.  Otherwise, see below for a description of the contents of

   * this field.

   */

  public Token next;

  /**

   * This field is used to access special tokens that occur prior to this

   * token, but after the immediately preceding regular (non-special) token.

   * If there are no such special tokens, this field is set to null.

   * When there are more than one such special token, this field refers

   * to the last of these special tokens, which in turn refers to the next

   * previous special token through its specialToken field, and so on

   * until the first special token (whose specialToken field is null).

   * The next fields of special tokens refer to other special tokens that

   * immediately follow it (without an intervening regular token).  If there

   * is no such token, this field is null.

   */

  public Token specialToken;

  /**

   * An optional attribute value of the Token.

   * Tokens which are not used as syntactic sugar will often contain

   * meaningful values that will be used later on by the compiler or

   * interpreter. This attribute value is often different from the image.

   * Any subclass of Token that actually wants to return a non-null value can

   * override this method as appropriate.

   */

  public Object getValue() {

    return null;

  }

  /**

   * No-argument constructor

   */

  public Token() {}

  /**

   * Constructs a new token for the specified Image.

   */

  public Token(int kind)

  {

    this(kind, null);

  }

  /**

   * Constructs a new token for the specified Image and Kind.

   */

  public Token(int kind, String image)

  {

    this.kind = kind;

    this.image = image;

  }

  /**

   * Returns the image.

   */

  public String toString()

  {

    return image;

  }

  /**

   * Returns a new Token object, by default. However, if you want, you

   * can create and return subclass objects based on the value of ofKind.

   * Simply add the cases to the switch for all those special cases.

   * For example, if you have a subclass of Token called IDToken that

   * you want to create if ofKind is ID, simply add something like :

   *

   *    case MyParserConstants.ID : return new IDToken(ofKind, image);

   *

   * to the following switch statement. Then you can cast matchedToken

   * variable to the appropriate type and use sit in your lexical actions.

   */

  public static Token newToken(int ofKind, String image)

  {

    switch(ofKind)

    {

      default : return new Token(ofKind, image);

    }

  }

  public static Token newToken(int ofKind)

  {

    return newToken(ofKind, null);

  }

}

/* JavaCC - OriginalChecksum=07395369f4a62ea6ce44cc3487e30e69 (do not edit this line) */