org.eclipse.jface.text.rules.IToken Maven / Gradle / Ivy
/*******************************************************************************
* Copyright (c) 2000, 2005 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.jface.text.rules;
/**
* A token to be returned by a rule.
* Originally since unknown version, but moved to org.eclipse.text in 3.14
*
* @since 3.14
*/
public interface IToken {
/**
* Return whether this token is undefined.
*
* @return true
if this token is undefined
*/
boolean isUndefined();
/**
* Return whether this token represents a whitespace.
*
* @return true
if this token represents a whitespace
*/
boolean isWhitespace();
/**
* Return whether this token represents End Of File.
*
* @return true
if this token represents EOF
*/
boolean isEOF();
/**
* Return whether this token is neither undefined, nor whitespace, nor EOF.
*
* @return true
if this token is not undefined, not a whitespace, and not EOF
*/
boolean isOther();
/**
* Return a data attached to this token. The semantics of this data kept undefined by this interface.
*
* @return the data attached to this token.
*/
Object getData();
}