Package com.intellij.psi

Interface PsiModifierList

All Superinterfaces:

Iconable, PsiAnnotationOwner, PsiElement, UserDataHolder

All Known Subinterfaces:

GrModifierList

All Known Implementing Classes:

ClsModifierListImpl, GrLightModifierList, GrModifierListImpl, LightModifierList, PsiCompositeModifierList, PsiModifierListImpl

public interface PsiModifierList
extends PsiElement, PsiAnnotationOwner

Represents the list of modifiers and annotations on a Java element (class, method, field and so on). Possible modifiers are defined as constants in the PsiModifier class.

See Also:

PsiModifierListOwner.getModifierList()

Nested Class Summary

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

Iconable.IconFlags, Iconable.LastComputedIcon

Field Summary

Fields inherited from interface com.intellij.psi.PsiElement

ARRAY_FACTORY, EMPTY_ARRAY

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
void	checkSetModifierProperty(java.lang.String name, boolean value) Checks if it is possible to add or remove the specified modifier to the modifier list, and throws an exception if the operation is not possible.
boolean	hasExplicitModifier(java.lang.String name) Checks if the modifier list has the specified modifier set by an explicit keyword.
boolean	hasModifierProperty(java.lang.String name) Checks if the modifier list has the specified modifier set either by an explicit keyword or implicitly (for example, interface methods are implicitly public).
void	setModifierProperty(java.lang.String name, boolean value) Adds or removes the specified modifier to the modifier list.

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.PsiAnnotationOwner

addAnnotation, findAnnotation, getAnnotations, getApplicableAnnotations, hasAnnotation

Method Detail

hasModifierProperty

boolean hasModifierProperty(java.lang.String name)

Checks if the modifier list has the specified modifier set either by an explicit keyword or implicitly (for example, interface methods are implicitly public).

Parameters:

name - the name of the modifier to check.

Returns:

true if the list has the modifier, false otherwise

See Also:

hasExplicitModifier(String)

hasExplicitModifier

boolean hasExplicitModifier(java.lang.String name)

Checks if the modifier list has the specified modifier set by an explicit keyword.

Parameters:

name - the name of the modifier to check.

Returns:

true if the list has the modifier, false otherwise

See Also:

hasModifierProperty(String)

setModifierProperty

void setModifierProperty(java.lang.String name,
                         boolean value)
                  throws IncorrectOperationException

Adds or removes the specified modifier to the modifier list.

Parameters:

name - the name of the modifier to add or remove.

value - true if the modifier should be added, false if it should be removed.

Throws:

IncorrectOperationException - if the modification fails for some reason.

checkSetModifierProperty

void checkSetModifierProperty(java.lang.String name,
                              boolean value)
                       throws IncorrectOperationException

Checks if it is possible to add or remove the specified modifier to the modifier list, and throws an exception if the operation is not possible. Does not actually modify anything.

Parameters:

name - the name of the modifier to check the add or remove possibility for.

value - true if the modifier should be added, false if it should be removed.

Throws:

IncorrectOperationException - if the modification fails for some reason.