Quelle TokenId.java

Sprache: JAVA

/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/

package org.netbeans.api.lexer;

/**
* Identifier of a token (could also be called a token-type).
* 
* It is not a token, because it does not contain
* the text (also called image) of the token.
*
* 
* Token ids are typically defined as enums by the following pattern:
* <pre>
* public enum JavaTokenId implements TokenId {
*
* ERROR(null, "error"),
* IDENTIFIER(null, "identifier"),
* ABSTRACT("abstract", "keyword"),
* ...
* SEMICOLON(";", "separator"),
* ...
*
*
* private final String fixedText; // Used by lexer for production of flyweight tokens
*
* private final String primaryCategory;
*
* JavaTokenId(String fixedText, String primaryCategory) {
* this.fixedText = fixedText;
* this.primaryCategory = primaryCategory;
* }
*
* public String fixedText() {
* return fixedText;
* }
*
* public String primaryCategory() {
* return primaryCategory;
* }
*
* }
* </pre>
*
* 
* Token ids can also be generated (e.g. by lexer generation tools)
* by using {@link org.netbeans.spi.lexer.LanguageHierarchy#newId(String,int,String)} method.
* 
* All token ids of a language must have both
* unique ordinal and name.
* 
* Token name should be all uppercase while token categories should be named
* in lowercase.
*
* 
* Detailed information and rules for naming can be found
* in <A href="https://netbeans.apache.org/projects/lexer/token-id-naming">TokenId Naming</A>.
*
* @author Miloslav Metelka
* @version 1.00
*/

public interface TokenId {

 /**
 * Get name of this tokenId.
 * 
 * It can serve for several purposes such as finding
 * a possible style information for the given token.
 * 
 *
 * @return non-null unique name of the TokenId. The name must be unique
 * among other TokenId instances of the particular language
 * where it is defined. The name should consist of
 * uppercase alphanumeric letters and underscores only.
 */
 String name();

 /**
 * Get integer identification of this tokenId.
 *
 * @return numeric identification of this TokenId.
 * 
 * Ordinal must be a non-negative
 * integer unique among all the tokenIDs inside the language
 * where it is declared.
 * 
 * The ordinals are usually defined and adopted from lexer
 * generator tool that generates the lexer for the given language.
 * 
 * They do not have to be consecutive.
 * 
 * On they other hand there should
 * not be big gaps (e.g. 100 or more) because
 * indexing arrays are constructed based on the ordinal values
 * so the length of the indexing array corresponds
 * to the highest ordinal of all the token ids declared
 * for the particular language.
 * 
 * The intIds allow more efficient use
 * of the tokenIds in switch-case statements.
 */
 int ordinal();

 /**
 * Get name of primary token category into which this token belongs.
 * 
 * Other token categories for this id can be defined in the language hierarchy.
 *
 * @return name of the primary token category into which this token belongs
 * or null if there is no primary category for this token.
 */
 String primaryCategory();

}

Messung V0.5 in Prozent

¤ Dauer der Verarbeitung: 0.11 Sekunden (vorverarbeitet am 2026-06-25) ¤

Wurzel

Suchen

PVS Prover

Isabelle Prover

NIST Cobol Testsuite

Cephes Mathematical Library

Vienna Development Method

Haftungshinweis

Die Informationen auf dieser Webseite wurden nach bestem Wissen sorgfältig zusammengestellt. Es wird jedoch weder Vollständigkeit, noch Richtigkeit, noch Qualität der bereit gestellten Informationen zugesichert.

Bemerkung:

Die farbliche Syntaxdarstellung und die Messung sind noch experimentell.