Package com.intellij.psi

Interface PsiCodeBlock

All Superinterfaces:

Iconable, PsiElement, PsiModifiableCodeBlock, UserDataHolder

All Known Subinterfaces:

JspCodeBlock

All Known Implementing Classes:

GrSyntheticCodeBlock, PsiCodeBlockImpl

public interface PsiCodeBlock
extends PsiElement, PsiModifiableCodeBlock

Represents a Java code block, usually surrounded by curly braces.

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.util.Iconable

Iconable.IconFlags, Iconable.LastComputedIcon

Field Summary

Fields

Modifier and Type	Field and Description
static PsiCodeBlock[]	EMPTY_ARRAY The empty array of PSI code blocks which can be reused to avoid unnecessary allocations.

Fields inherited from interface com.intellij.psi.PsiElement

ARRAY_FACTORY

Fields inherited from interface com.intellij.openapi.util.Iconable

ICON_FLAG_IGNORE_MASK, ICON_FLAG_OPEN, ICON_FLAG_READ_STATUS, ICON_FLAG_VISIBILITY

Method Summary

Modifier and Type	Method and Description
PsiElement	getFirstBodyElement() Returns the first PSI element contained in the block.
PsiElement	getLastBodyElement() Returns the last PSI element contained in the block.
PsiJavaToken	getLBrace() Returns the opening curly brace of the block.
PsiJavaToken	getRBrace() Returns the closing curly brace of the block.
default int	getStatementCount()
PsiStatement []	getStatements() Returns the array of statements contained in the block. Please note that this method doesn't return comments which are not part of statements.
default boolean	isEmpty()

Methods inherited from interface com.intellij.psi.PsiElement

accept, acceptChildren, add, addAfter, addBefore, addRange, addRangeAfter, addRangeBefore, checkAdd, checkDelete, copy, delete, deleteChildRange, findElementAt, findReferenceAt, getChildren, getContainingFile, getContext, getCopyableUserData, getFirstChild, getLanguage, getLastChild, getManager, getNavigationElement, getNextSibling, getNode, getOriginalElement, getOwnReferences, getParent, getPrevSibling, getProject, getReference, getReferences, getResolveScope, getStartOffsetInParent, getText, getTextLength, getTextOffset, getTextRange, getTextRangeInParent, getUseScope, isEquivalentTo, isPhysical, isValid, isWritable, processDeclarations, putCopyableUserData, replace, textContains, textMatches, textMatches, textToCharArray, toString

Methods inherited from interface com.intellij.openapi.util.UserDataHolder

getUserData, putUserData

Methods inherited from interface com.intellij.openapi.util.Iconable

getIcon

Methods inherited from interface com.intellij.psi.PsiModifiableCodeBlock

shouldChangeModificationCount

Field Detail

EMPTY_ARRAY

static final PsiCodeBlock[] EMPTY_ARRAY

The empty array of PSI code blocks which can be reused to avoid unnecessary allocations.

Method Detail

getStatements

PsiStatement [] getStatements()

Returns the array of statements contained in the block.
Please note that this method doesn't return comments which are not part of statements.

Returns:

the array of statements.

getFirstBodyElement

PsiElement getFirstBodyElement()

Returns the first PSI element contained in the block.

Returns:

the first PSI element, or null if the block is empty.

getLastBodyElement

PsiElement getLastBodyElement()

Returns the last PSI element contained in the block.

Returns:

the last PSI element, or null if the block is empty.

getLBrace

PsiJavaToken getLBrace()

Returns the opening curly brace of the block.

Returns:

the opening curly brace, or null if the block does not have one.

getRBrace

PsiJavaToken getRBrace()

Returns the closing curly brace of the block.

Returns:

the closing curly brace, or null if the block does not have one.

getStatementCount

default int getStatementCount()

Returns:

number of statements this code block contains.

isEmpty

default boolean isEmpty()

Returns:

true if this code block contains no statements. Note that if code block contains empty statements or empty code blocks inside, this method will return false.