Uses of Interface org.netbeans.api.lexer.TokenId (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 NEXT

FRAMES NO FRAMES

Uses of Interface
org.netbeans.api.lexer.TokenId

Packages that use TokenId
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.
org.netbeans.spi.lexer	The main abstract class in the Lexer SPI that must be implemented is `LanguageHierarchy` that mainly defines set of token ids and token categories for the new language and its `Lexer`.

Uses of TokenId in org.netbeans.api.lexer

Classes in org.netbeans.api.lexer with type parameters of type TokenId

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

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

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

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

Classes in org.netbeans.api.lexer with type parameters of type TokenId
`class`	`Language<T extends TokenId>` Language describes a set of token ids that comprise the given language.
`class`	`Token<T extends TokenId>` Token describes a lexical element of input text.
`class`	`TokenChange<T extends TokenId>` Token change describes modification on one level of a token hierarchy.
`class`	`TokenSequence<T extends TokenId>` Token sequence allows to iterate between tokens of a token hierarchy.

Methods in org.netbeans.api.lexer with type parameters of type TokenId

static <T extends TokenId> TokenHierarchy<Void> TokenHierarchy.create(CharSequence inputText, boolean copyInputText, Language<T> language, Set<T> skipTokenIds, InputAttributes inputAttributes)
          Create token hierarchy for the given input text.

static <T extends TokenId> TokenHierarchy<Void> TokenHierarchy.create(Reader inputReader, Language<T> language, Set<T> skipTokenIds, InputAttributes inputAttributes)
          Create token hierarchy for the given reader.

<ET extends TokenId> TokenSequence<ET> TokenSequence.embedded(Language<ET> embeddedLanguage)
          Get embedded token sequence if the token to which this token sequence is currently positioned has a language embedding.

<T extends TokenId> TokenChange<T> TokenChange.embeddedChange(Language<T> language)
          Get embedded token change of the given type.

<T extends TokenId> TokenChange<T> TokenHierarchyEvent.tokenChange(Language<T> language)
          Get the token change if the top level of the token hierarchy contains tokens of the given language.

<T extends TokenId> TokenSequence<T> TokenHierarchy.tokenSequence(Language<T> language)
          Get token sequence of the top level of the language hierarchy only if it's of the given language.

Methods in org.netbeans.api.lexer that return types with arguments of type TokenId

TokenSequence<? extends TokenId> TokenSequence.embedded()
          Get embedded token sequence if the token to which this token sequence is currently positioned has a language embedding.

TokenChange<? extends TokenId> TokenChange.embeddedChange(int index)
          Get embedded change at the given index.

static Language<? extends TokenId> Language.find(String mimePath)
          Finds a language by its mime type.

Language<? extends TokenId> LanguagePath.innerLanguage()
          Return the most inner language of this path.

Language<? extends TokenId> LanguagePath.language(int index)
          Get language of this language path at the given index.

TokenChange<? extends TokenId> TokenHierarchyEvent.tokenChange()
          Get the token change that occurred in the tokens at the top-level of the token hierarchy.

TokenSequence<? extends TokenId> TokenHierarchy.tokenSequence()
          Get token sequence of the top level language of the token hierarchy.

List<TokenSequence<? extends TokenId>> TokenHierarchy.tokenSequenceList(LanguagePath languagePath, int startOffset, int endOffset)
          Get list of token sequences with the given language path from this hierarchy.

Language<? extends TokenId> LanguagePath.topLanguage()
          Return the top-level language of this language path.

Methods in org.netbeans.api.lexer that return types with arguments of type TokenId
`TokenSequence<? extends TokenId>`	`TokenSequence.embedded()` Get embedded token sequence if the token to which this token sequence is currently positioned has a language embedding.
`TokenChange<? extends TokenId>`	`TokenChange.embeddedChange(int index)` Get embedded change at the given index.
`static Language<? extends TokenId>`	`Language.find(String mimePath)` Finds a language by its mime type.
`Language<? extends TokenId>`	`LanguagePath.innerLanguage()` Return the most inner language of this path.
`Language<? extends TokenId>`	`LanguagePath.language(int index)` Get language of this language path at the given index.
`TokenChange<? extends TokenId>`	`TokenHierarchyEvent.tokenChange()` Get the token change that occurred in the tokens at the top-level of the token hierarchy.
`TokenSequence<? extends TokenId>`	`TokenHierarchy.tokenSequence()` Get token sequence of the top level language of the token hierarchy.
`List<TokenSequence<? extends TokenId>>`	`TokenHierarchy.tokenSequenceList(LanguagePath languagePath, int startOffset, int endOffset)` Get list of token sequences with the given language path from this hierarchy.
`Language<? extends TokenId>`	`LanguagePath.topLanguage()` Return the top-level language of this language path.

Method parameters in org.netbeans.api.lexer with type arguments of type TokenId

static TokenHierarchy<Void> TokenHierarchy.create(CharSequence inputText, Language<? extends TokenId> language)
          Create token hierarchy for the given non-mutating input text (for example java.lang.String).

boolean TokenSequence.createEmbedding(Language<? extends TokenId> embeddedLanguage, int startSkipLength, int endSkipLength)
          Create language embedding without joining of the embedded sections.

boolean TokenSequence.createEmbedding(Language<? extends TokenId> embeddedLanguage, int startSkipLength, int endSkipLength, boolean joinSections)
          Create language embedding described by the given parameters.

LanguagePath LanguagePath.embedded(Language<? extends TokenId> language)
          Get embedded path of this language path.

static LanguagePath LanguagePath.get(Language<? extends TokenId> language)
          Get language path that contains a single language.

static LanguagePath LanguagePath.get(LanguagePath prefix, Language<? extends TokenId> language)
          Get language path corresponding to the language embedded in the given context language path.

boolean LanguagePath.isInnerLanguage(Language<? extends TokenId> language)
          Check whether the most inner language of this language path is the given language.

boolean LanguagePath.isLanguage(int index, Language<? extends TokenId> language)
          Check whether the language of this language path at the given index is the given language.

boolean LanguagePath.isTopLanguage(Language<? extends TokenId> language)
          Check whether the top-level language of this language path is the given language.

void InputAttributes.setValue(Language<? extends TokenId> language, Object attributeKey, Object attributeValue, boolean global)
          Assign a new value to a property for the language path constructed from the given language.

Method parameters in org.netbeans.api.lexer with type arguments of type TokenId
`static TokenHierarchy<Void>`	`TokenHierarchy.create(CharSequence inputText, Language<? extends TokenId> language)` Create token hierarchy for the given non-mutating input text (for example java.lang.String).
`boolean`	`TokenSequence.createEmbedding(Language<? extends TokenId> embeddedLanguage, int startSkipLength, int endSkipLength)` Create language embedding without joining of the embedded sections.
`boolean`	`TokenSequence.createEmbedding(Language<? extends TokenId> embeddedLanguage, int startSkipLength, int endSkipLength, boolean joinSections)` Create language embedding described by the given parameters.
`LanguagePath`	`LanguagePath.embedded(Language<? extends TokenId> language)` Get embedded path of this language path.
`static LanguagePath`	`LanguagePath.get(Language<? extends TokenId> language)` Get language path that contains a single language.
`static LanguagePath`	`LanguagePath.get(LanguagePath prefix, Language<? extends TokenId> language)` Get language path corresponding to the language embedded in the given context language path.
`boolean`	`LanguagePath.isInnerLanguage(Language<? extends TokenId> language)` Check whether the most inner language of this language path is the given language.
`boolean`	`LanguagePath.isLanguage(int index, Language<? extends TokenId> language)` Check whether the language of this language path at the given index is the given language.
`boolean`	`LanguagePath.isTopLanguage(Language<? extends TokenId> language)` Check whether the top-level language of this language path is the given language.
`void`	`InputAttributes.setValue(Language<? extends TokenId> language, Object attributeKey, Object attributeValue, boolean global)` Assign a new value to a property for the language path constructed from the given language.

Uses of TokenId in org.netbeans.spi.lexer

Classes in org.netbeans.spi.lexer with type parameters of type TokenId

class LanguageEmbedding<T extends TokenId>
          Description of a particular language embedding including starting and ending skipped regions of a token containing this embedding and a definition of an embedded language hierarchy.

class LanguageHierarchy<T extends TokenId>
          Definition of a language, its lexer and its embedded languages.

interface Lexer<T extends TokenId>
          Lexer reads input characters from LexerInput and groups them into tokens.

class LexerRestartInfo<T extends TokenId>
          Lexer restart info contains all the necessary information for restarting of a lexer mainly the lexer input, state and token factory.

class TokenFactory<T extends TokenId>
          Lexer should delegate all the token instances creation to this class.

interface TokenPropertyProvider<T extends TokenId>
          Provides extra properties of a token.

interface TokenValidator<T extends TokenId>
          Token validator checks whether an existing token was affected by just performed input source modification so that it needs to be relexed.

Classes in org.netbeans.spi.lexer with type parameters of type TokenId
`class`	`LanguageEmbedding<T extends TokenId>` Description of a particular language embedding including starting and ending skipped regions of a token containing this embedding and a definition of an embedded language hierarchy.
`class`	`LanguageHierarchy<T extends TokenId>` Definition of a language, its lexer and its embedded languages.
`interface`	`Lexer<T extends TokenId>` Lexer reads input characters from `LexerInput` and groups them into tokens.
`class`	`LexerRestartInfo<T extends TokenId>` Lexer restart info contains all the necessary information for restarting of a lexer mainly the lexer input, state and token factory.
`class`	`TokenFactory<T extends TokenId>` Lexer should delegate all the token instances creation to this class.
`interface`	`TokenPropertyProvider<T extends TokenId>` Provides extra properties of a token.
`interface`	`TokenValidator<T extends TokenId>` Token validator checks whether an existing token was affected by just performed input source modification so that it needs to be relexed.

Methods in org.netbeans.spi.lexer with type parameters of type TokenId

static <T extends TokenId> LanguageEmbedding<T> LanguageEmbedding.create(Language<T> language, int startSkipLength, int endSkipLength)
Create language embedding that does not join embedded sections.

static <T extends TokenId> LanguageEmbedding<T> LanguageEmbedding.create(Language<T> language, int startSkipLength, int endSkipLength, boolean joinSections)
Construct new language embedding for the given parameters or get an existing cached one.

Methods in org.netbeans.spi.lexer that return TokenId

static TokenId LanguageHierarchy.newId(String name, int ordinal)
Create a default token id instance in case the token ids are generated (not created by enum class).

static TokenId LanguageHierarchy.newId(String name, int ordinal, String primaryCategory)
Create a default token id instance in case the token ids are generated (not created by enum class).

Methods in org.netbeans.spi.lexer that return TokenId
`static TokenId`	`LanguageHierarchy.newId(String name, int ordinal)` Create a default token id instance in case the token ids are generated (not created by enum class).
`static TokenId`	`LanguageHierarchy.newId(String name, int ordinal, String primaryCategory)` Create a default token id instance in case the token ids are generated (not created by enum class).

Methods in org.netbeans.spi.lexer that return types with arguments of type TokenId

protected LanguageEmbedding<? extends TokenId> LanguageHierarchy.embedding(Token<T> token, LanguagePath languagePath, InputAttributes inputAttributes)
          Get language embedding (if exists) for a particular token of the language at this level of language hierarchy.

abstract Language<? extends TokenId> LanguageProvider.findLanguage(String mimePath)
          Finds Language for a given mime path.

abstract LanguageEmbedding<? extends TokenId> LanguageProvider.findLanguageEmbedding(Token<? extends TokenId> token, LanguagePath languagePath, InputAttributes inputAttributes)
          Finds LanguageEmbedding that will define what language is embedded in a given token.

protected abstract Language<? extends TokenId> MutableTextInput.language()
          Get the language suitable for lexing of this input.

Methods in org.netbeans.spi.lexer that return types with arguments of type TokenId
`protected LanguageEmbedding<? extends TokenId>`	`LanguageHierarchy.embedding(Token<T> token, LanguagePath languagePath, InputAttributes inputAttributes)` Get language embedding (if exists) for a particular token of the language at this level of language hierarchy.
`abstract Language<? extends TokenId>`	`LanguageProvider.findLanguage(String mimePath)` Finds `Language` for a given mime path.
`abstract LanguageEmbedding<? extends TokenId>`	`LanguageProvider.findLanguageEmbedding(Token<? extends TokenId> token, LanguagePath languagePath, InputAttributes inputAttributes)` Finds `LanguageEmbedding` that will define what language is embedded in a given token.
`protected abstract Language<? extends TokenId>`	`MutableTextInput.language()` Get the language suitable for lexing of this input.

Method parameters in org.netbeans.spi.lexer with type arguments of type TokenId

abstract LanguageEmbedding<? extends TokenId> LanguageProvider.findLanguageEmbedding(Token<? extends TokenId> token, LanguagePath languagePath, InputAttributes inputAttributes)
Finds LanguageEmbedding that will define what language is embedded in a given token.

Method parameters in org.netbeans.spi.lexer with type arguments of type TokenId
`abstract LanguageEmbedding<? extends TokenId>`	`LanguageProvider.findLanguageEmbedding(Token<? extends TokenId> token, LanguagePath languagePath, InputAttributes inputAttributes)` Finds `LanguageEmbedding` that will define what language is embedded in a given token.