Package com.intellij.psi.tree

Class IElementType

java.lang.Object

com.intellij.psi.tree.IElementType

Direct Known Subclasses:

BuildoutCfgElementType, CustomHighlighterTokenType.CustomElementType, CustomParsingType, GroovyDocElementType, GroovyElementType, IDTDElementType, IgnoreElementType, IgnoreTokenType, IJavaDocElementType, IJavaElementType, IJspElementType, ILazyParseableElementType, IStubElementType, IXmlElementType, JqlElementType, JsonElementType, JsonTokenType, ManifestElementType, ManifestTokenType, MarkdownElementType, PrattTokenType, PropertiesElementType, PyElementType, RegExpElementType, RestElementType, RncElementType, ScopeTokenType, ShCompositeElementType, ShTokenType, SPIElementType, TextMateElementType, TokenWrapper, XPathElementType, YAMLElementType

public class IElementType
extends java.lang.Object

Interface for token types returned from lexical analysis and for types of nodes in the AST tree. All used element types are added to a registry which can be enumerated or accessed by index.

See Also:

Lexer.getTokenType(), ASTNode.getElementType()

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	IElementType.Predicate Predicate for matching element types.

Field Summary

Fields

Modifier and Type	Field and Description
static ArrayFactory<IElementType>	ARRAY_FACTORY
static IElementType[]	EMPTY_ARRAY
static short	FIRST_TOKEN_INDEX
static IElementType.Predicate	TRUE Default enumeration predicate which matches all token types.

Constructor Summary

Constructors

Modifier	Constructor and Description
	IElementType(java.lang.String debugName, Language language) Creates and registers a new element type for the specified language.
protected	IElementType(java.lang.String debugName, Language language, boolean register) Allows to construct element types for some temporary purposes without registering them.

Method Summary

Modifier and Type	Method and Description
static IElementType []	enumerate(IElementType.Predicate p) Enumerates all registered token types which match the specified predicate.
static IElementType	find(short idx) Returns the element type registered at the specified index.
short	getIndex() Returns the index of the element type in the table of all registered element types.
Language	getLanguage() Returns the language associated with the element type.
int	hashCode()
boolean	isLeftBound() Controls whitespace balancing behavior of PsiBuilder.
java.lang.String	toString()
static void	unregisterElementTypes(java.lang.ClassLoader loader)
static void	unregisterElementTypes(Language language)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

EMPTY_ARRAY

public static final IElementType[] EMPTY_ARRAY

ARRAY_FACTORY

public static final ArrayFactory<IElementType> ARRAY_FACTORY

TRUE

public static final IElementType.Predicate TRUE

Default enumeration predicate which matches all token types.

See Also:

enumerate(Predicate)

FIRST_TOKEN_INDEX

public static final short FIRST_TOKEN_INDEX

See Also:

Constant Field Values

Constructor Detail

IElementType

public IElementType(java.lang.String debugName,
                    Language language)

Creates and registers a new element type for the specified language.

Parameters:

debugName - the name of the element type, used for debugging purposes.

language - the language with which the element type is associated.

IElementType

protected IElementType(java.lang.String debugName,
                       Language language,
                       boolean register)

Allows to construct element types for some temporary purposes without registering them. This is not default behavior and not recommended. A lot of other functionality (e.g. TokenSet) won't work with such element types. Please use IElementType(String, Language) unless you know what you're doing.

Method Detail

unregisterElementTypes

public static void unregisterElementTypes(java.lang.ClassLoader loader)

unregisterElementTypes

public static void unregisterElementTypes(Language language)

getLanguage

public Language getLanguage()

Returns the language associated with the element type.

Returns:

the associated language.

getIndex

public final short getIndex()

Returns the index of the element type in the table of all registered element types.

Returns:

the element type index.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isLeftBound

public boolean isLeftBound()

Controls whitespace balancing behavior of PsiBuilder.

By default, empty composite elements (containing no children) are bounded to the right (previous) neighbour, forming following tree:

  [previous_element]
  [whitespace]
  [empty_element]
    <empty>
  [next_element]
 

Left-bound elements are bounded to the left (next) neighbour instead:

  [previous_element]
  [empty_element]
    <empty>
  [whitespace]
  [next_element]
 

See com.intellij.lang.impl.PsiBuilderImpl.prepareLightTree() for details.

Returns:

true if empty elements of this type should be bound to the left.

find

public static IElementType find(short idx)

Returns the element type registered at the specified index.

Parameters:

idx - the index for which the element type should be returned.

Returns:

the element type at the specified index.

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of registered elements' range.

enumerate

public static IElementType [] enumerate(IElementType.Predicate p)

Enumerates all registered token types which match the specified predicate.

Parameters:

p - the predicate which should be matched by the element types.

Returns:

the array of matching element types.