/*
 * Hibernate, Relational Persistence for Idiomatic Java
 *
 * License: GNU Lesser General Public License (LGPL), version 2.1 or later.
 * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
 */
package org.hibernate.hql.internal.ast;

A custom token class for the HQL grammar.
NOTE: This class must be public becuase it is instantiated by the ANTLR library.  Ignore any suggestions
by various code 'analyzers' about this class being package local.

/**
 * A custom token class for the HQL grammar.
 * <p><i>NOTE:<i> This class must be public becuase it is instantiated by the ANTLR library.  Ignore any suggestions
 * by various code 'analyzers' about this class being package local.</p>
 */
public class HqlToken extends antlr.CommonToken {
	
True if this token could be an identifier.
/**
	 * True if this token could be an identifier.
	 */
	private boolean possibleID;
	
The previous token type.
/**
	 * The previous token type.
	 */
	private int tokenType;

	
Returns true if the token could be an identifier.
Returns:
True if the token could be interpreted as in identifier,
        false if not./**
	 * Returns true if the token could be an identifier.
	 *
	 * @return True if the token could be interpreted as in identifier,
	 *         false if not.
	 */
	public boolean isPossibleID() {
		return possibleID;
	}

	
Sets the type of the token, remembering the previous type.
Params:
t – The new token type./**
	 * Sets the type of the token, remembering the previous type.
	 *
	 * @param t The new token type.
	 */
	@Override
	public void setType(int t) {
		this.tokenType = getType();
		super.setType( t );
	}

	
Returns the previous token type.
Returns:
int - The old token type./**
	 * Returns the previous token type.
	 *
	 * @return int - The old token type.
	 */
	private int getPreviousType() {
		return tokenType;
	}

	
Set to true if this token can be interpreted as an identifier,
false if not.
Params:
possibleID – True if this is a keyword/identifier, false if not./**
	 * Set to true if this token can be interpreted as an identifier,
	 * false if not.
	 *
	 * @param possibleID True if this is a keyword/identifier, false if not.
	 */
	public void setPossibleID(boolean possibleID) {
		this.possibleID = possibleID;
	}

	
Returns a string representation of the object.
Returns:
String - The debug string./**
	 * Returns a string representation of the object.
	 *
	 * @return String - The debug string.
	 */
	@Override
	public String toString() {
		return "[\""
				+ getText()
				+ "\",<" + getType() + "> previously: <" + getPreviousType() + ">,line="
				+ line + ",col="
				+ col + ",possibleID=" + possibleID + "]";
	}

}