Package com.intellij.lang

Interface PsiBuilder.Marker

All Known Implementing Classes:

DelegateMarker, IndentPsiBuilder.MyMarker

Enclosing interface:

PsiBuilder

public static interface PsiBuilder.Marker

A marker defines a range in the document text which becomes a node in the AST tree. The ranges defined by markers within the text range of the current marker become child nodes of the node defined by the current marker.

Method Summary

Modifier and Type	Method and Description
void	collapse(IElementType type) Like done(IElementType), but collapses all tokens between start and end markers into single leaf node of given type.
void	done(IElementType type) Completes this marker and labels it with the specified AST node type.
void	doneBefore(IElementType type, PsiBuilder.Marker before) Like done(IElementType), but the marker is completed (end marker inserted) before specified one.
void	doneBefore(IElementType type, PsiBuilder.Marker before, java.lang.String errorMessage) Like #doneBefore(IElementType, Marker), but in addition an error element with given text is inserted right before this marker's end.
void	drop() Drops this marker.
void	error(java.lang.String message) Completes this marker and labels it as error element with specified message.
void	errorBefore(java.lang.String message, PsiBuilder.Marker before) Like error(String), but the marker is completed before specified one.
PsiBuilder.Marker	precede() Creates and returns a new marker starting immediately before the start of this marker and extending after its end.
void	rollbackTo() Drops this marker and all markers added after it, and reverts the lexer position to the position of this marker.
void	setCustomEdgeTokenBinders(WhitespacesAndCommentsBinder left, WhitespacesAndCommentsBinder right) Allows to define custom edge token binders instead of default ones.

Method Detail

precede

PsiBuilder.Marker precede()

Creates and returns a new marker starting immediately before the start of this marker and extending after its end. Can be called on a completed or a currently active marker.

Returns:

the new marker instance.

drop

void drop()

Drops this marker. Can be called after other markers have been added and completed after this marker. Does not affect lexer position or markers added after this marker.

rollbackTo

void rollbackTo()

Drops this marker and all markers added after it, and reverts the lexer position to the position of this marker.

done

void done(IElementType type)

Completes this marker and labels it with the specified AST node type. Before calling this method, all markers added after the beginning of this marker must be either dropped or completed.

Parameters:

type - the type of the node in the AST tree.

collapse

void collapse(IElementType type)

Like done(IElementType), but collapses all tokens between start and end markers into single leaf node of given type.

Parameters:

type - the type of the node in the AST tree.

doneBefore

void doneBefore(IElementType type,
                PsiBuilder.Marker before)

Like done(IElementType), but the marker is completed (end marker inserted) before specified one. All markers added between start of this marker and the marker specified as end one must be either dropped or completed.

Parameters:

type - the type of the node in the AST tree.

before - marker to complete this one before.

doneBefore

void doneBefore(IElementType type,
                PsiBuilder.Marker before,
                java.lang.String errorMessage)

Like #doneBefore(IElementType, Marker), but in addition an error element with given text is inserted right before this marker's end.

Parameters:

type - the type of the node in the AST tree.

before - marker to complete this one before.

errorMessage - for error element.

error

void error(java.lang.String message)

Completes this marker and labels it as error element with specified message. Before calling this method, all markers added after the beginning of this marker must be either dropped or completed.

Parameters:

message - for error element.

errorBefore

void errorBefore(java.lang.String message,
                 PsiBuilder.Marker before)

Like error(String), but the marker is completed before specified one.

Parameters:

message - for error element.

before - marker to complete this one before.

setCustomEdgeTokenBinders

void setCustomEdgeTokenBinders(WhitespacesAndCommentsBinder left,
                               WhitespacesAndCommentsBinder right)

Allows to define custom edge token binders instead of default ones. If any of parameters is null then corresponding token binder won't be changed (keeping previously set or default token binder). It is an error to set right token binder for not-done marker.

Parameters:

left - new left edge token binder.

right - new right edge token binder.