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

/**
 * Redistribution and use of this software and associated documentation ("Software"), with or
 * without modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain copyright statements and notices. Redistributions
 * must also contain a copy of this document.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice, this list of
 * conditions and the following disclaimer in the documentation and/or other materials provided with
 * the distribution.
 *
 * 3. The name "Exolab" must not be used to endorse or promote products derived from this Software
 * without prior written permission of Intalio, Inc. For written permission, please contact
 * info@exolab.org.
 *
 * 4. Products derived from this Software may not be called "Exolab" nor may "Exolab" appear in
 * their names without prior written permission of Intalio, Inc. Exolab is a registered trademark of
 * Intalio, Inc.
 *
 * 5. Due credit should be given to the Exolab Project (http://www.exolab.org/).
 *
 * THIS SOFTWARE IS PROVIDED BY INTALIO, INC. AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESSED OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INTALIO, INC. OR ITS
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
 * WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Copyright 2000 (C) Intalio Inc. All Rights Reserved.
 *
 * $Id$
 */

package org.exolab.castor.xml.dtd.parser;

/**
 * Describes the input token stream.
 * 
 * @author Generated automatically by <b>JavaCC</b>
 * @version Version 0.7pre3
 */
public class Token {

  /**
   * 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;

  /**
   * beginLine and beginColumn describe the position of the first character of this token; endLine
   * and endColumn describe the position of the last character of this token.
   */
  public int beginLine, beginColumn, endLine, 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;

  /**
   * Returns the image.
   */
  public final 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, simlpy add something like :
   *
   * case MyParserConstants.ID : return new IDToken();
   *
   * to the following switch statement. Then you can cast matchedToken variable to the appropriate
   * type and use it in your lexical actions.
   */
  public static final Token newToken(int ofKind) {
    switch (ofKind) {
      default:
        return new Token();
    }
  }

}
