org.netbeans.api.lexer (Lexer) - NetBeans API Javadoc (Current Development Version)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

org.netbeans.modules.lexer/2 1.19.0 1

PREV PACKAGE NEXT PACKAGE

FRAMES NO FRAMES

Package org.netbeans.api.lexer

The entrance point into Lexer API is TokenHierarchy class with its static methods that provide its instance for the given input source.

See:
Description

Interface Summary

TokenHierarchyListener Listener for chagnes in the token hierarchy.

TokenId Identifier of a token (could also be called a token-type).

Interface Summary
TokenHierarchyListener	Listener for chagnes in the token hierarchy.
TokenId	Identifier of a token (could also be called a token-type).

Class Summary

InputAttributes Supplementary information about particular input that may be used to influence the lexer's operation.

Language<T extends TokenId> Language describes a set of token ids that comprise the given language.

LanguagePath Language path describes a complete embedding of the languages starting from the root (top-level) language till the most embedded language.

Token<T extends TokenId> Token describes a lexical element of input text.

TokenChange<T extends TokenId> Token change describes modification on one level of a token hierarchy.

TokenHierarchy<I> Token hierarchy represents a given input source as a browsable hierarchy of tokens.

TokenHierarchyEvent Description of the changes made in a token hierarchy.

TokenSequence<T extends TokenId> Token sequence allows to iterate between tokens of a token hierarchy.

TokenUtilities Various utility methods related to token text.

Class Summary
InputAttributes	Supplementary information about particular input that may be used to influence the lexer's operation.
Language<T extends TokenId>	Language describes a set of token ids that comprise the given language.
LanguagePath	Language path describes a complete embedding of the languages starting from the root (top-level) language till the most embedded language.
Token<T extends TokenId>	Token describes a lexical element of input text.
TokenChange<T extends TokenId>	Token change describes modification on one level of a token hierarchy.
TokenHierarchy<I>	Token hierarchy represents a given input source as a browsable hierarchy of tokens.
TokenHierarchyEvent	Description of the changes made in a token hierarchy.
TokenSequence<T extends TokenId>	Token sequence allows to iterate between tokens of a token hierarchy.
TokenUtilities	Various utility methods related to token text.

Enum Summary

PartType Whether Token represents a complete token or just a part of a complete token.

TokenHierarchyEventType Token hierarchy event type determines the reason why token hierarchy modification described by TokenHierarchyEvent happened.

Enum Summary
PartType	Whether `Token` represents a complete token or just a part of a complete token.
TokenHierarchyEventType	Token hierarchy event type determines the reason why token hierarchy modification described by `TokenHierarchyEvent` happened.

Package org.netbeans.api.lexer Description

The entrance point into Lexer API is TokenHierarchy class with its static methods that provide its instance for the given input source.
TokenHierarchy.tokenSequence() allows to walk through the tokens that were created for the given input.
Token models a single token recognized in the input. It carries a token identification TokenId returned by Token.id() and token text represented as CharSequence returned by Token.text().
Language represents all the token ids for a single language.
Each token id may belong to one or more token categories that allow to better operate tokens of the same type (e.g. keywords or operators).