Package com.intellij.lang

Class BracePair

java.lang.Object

com.intellij.lang.BracePair

public class BracePair
extends java.lang.Object

Defines a single pair of braces which need to be matched when editing code in a custom language.

See Also:

PairedBraceMatcher

Constructor Summary

Constructors

Constructor and Description
BracePair(IElementType leftBrace, IElementType rightBrace, boolean structural) Creates a new brace pair instance.

Method Summary

Modifier and Type	Method and Description
IElementType	getLeftBraceType() Returns the lexer token type for the left brace in the pair.
IElementType	getRightBraceType() Returns the lexer token type for the right brace in the pair.
boolean	isStructural() Returns true if the brace is structural.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BracePair

public BracePair(IElementType leftBrace,
                 IElementType rightBrace,
                 boolean structural)

Creates a new brace pair instance.

Parameters:

leftBrace - the lexer token type for the left brace in the pair.

rightBrace - the lexer token type for the right brace in the pair.

structural - if true, the brace is considered structural (see isStructural() for details)

Method Detail

getLeftBraceType

public IElementType getLeftBraceType()

Returns the lexer token type for the left brace in the pair.

Returns:

token type

getRightBraceType

public IElementType getRightBraceType()

Returns the lexer token type for the right brace in the pair.

Returns:

token type

isStructural

public boolean isStructural()

Returns true if the brace is structural. Structural braces have higher priority than regular braces: they are matched with each other even if there are unmatched braces of other types between them, and an opening non-structural brace is not matched with a closing one if one of them is outside a pair of matched structural braces and another is outside. In Java code, the curly braces are structural.

Returns:

true if the brace is structural, false otherwise.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object