Package com.intellij.psi.impl.light

Class LightModifierList

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.psi.impl.ElementBase

com.intellij.psi.impl.PsiElementBase

com.intellij.psi.impl.light.LightElement

com.intellij.psi.impl.light.LightModifierList

All Implemented Interfaces:

NavigationItem, Iconable, UserDataHolder, UserDataHolderEx, Navigatable, NavigatablePsiElement, PsiAnnotationOwner, PsiElement, PsiModifierList, java.lang.Cloneable

Direct Known Subclasses:

PsiCompositeModifierList

public class LightModifierList
extends LightElement
implements PsiModifierList

Nested Class Summary

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

Iconable.IconFlags, Iconable.LastComputedIcon

Field Summary

Fields inherited from class com.intellij.psi.impl.light.LightElement

myManager

Fields inherited from class com.intellij.psi.impl.ElementBase

FLAGS_LOCKED, ICON_PLACEHOLDER

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

Fields inherited from interface com.intellij.psi.NavigatablePsiElement

EMPTY_NAVIGATABLE_ELEMENT_ARRAY

Fields inherited from interface com.intellij.navigation.NavigationItem

EMPTY_NAVIGATION_ITEM_ARRAY

Constructor Summary

Constructors

Constructor and Description
LightModifierList(PsiManager manager)
LightModifierList(PsiManager manager, Language language, java.lang.String... modifiers)
LightModifierList(PsiModifierListOwner modifierListOwner)

Method Summary

Modifier and Type	Method and Description
void	accept(PsiElementVisitor visitor) Passes the element to the specified visitor.
PsiAnnotation	addAnnotation(java.lang.String qualifiedName) Adds a new annotation to this owner.
void	addModifier(java.lang.String modifier)
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.
void	clearModifiers()
void	copyModifiers(PsiModifierList modifierList)
PsiAnnotation	findAnnotation(java.lang.String qualifiedName) Searches the owner for an annotation with the specified fully qualified name and returns one if it is found.
PsiAnnotation []	getAnnotations() Returns the list of annotations syntactically contained in the element.
PsiAnnotation []	getApplicableAnnotations()
java.lang.String []	getModifiers()
java.lang.String	getText() Returns the text of the PSI element.
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.
java.lang.String	toString() toString() should never be presented to the user.

Methods inherited from class com.intellij.psi.impl.light.LightElement

add, addAfter, addBefore, checkAdd, checkDelete, copy, delete, findElementAt, getChildren, getContainingFile, getLanguage, getManager, getNavigationElement, getNextSibling, getNode, getParent, getPrevSibling, getStartOffsetInParent, getTextLength, getTextOffset, getTextRange, isPhysical, isValid, isWritable, replace, setNavigationElement, textMatches, textMatches, textToCharArray

Methods inherited from class com.intellij.psi.impl.PsiElementBase

acceptChildren, addRange, addRangeAfter, addRangeBefore, canNavigate, canNavigateToSource, deleteChildRange, findChildByClass, findChildrenByClass, findNotNullChildByClass, findReferenceAt, getContext, getFirstChild, getLastChild, getName, getOriginalElement, getPresentation, getProject, getReference, getReferences, getResolveScope, getUseScope, isEquivalentTo, navigate, notNullChild, processDeclarations, textContains

Methods inherited from class com.intellij.psi.impl.ElementBase

buildRowIcon, computeBaseIcon, createLayeredIcon, getAdjustedBaseIcon, getBaseIcon, getElementIcon, getIcon, iconWithVisibilityIfNeeded, isNativeFileType, isVisibilitySupported, overlayIcons, registerIconLayer, transformFlags

Methods inherited from class com.intellij.openapi.util.UserDataHolderBase

changeUserMap, clearUserData, clone, copyCopyableDataTo, copyUserDataTo, getCopyableUserData, getUserData, getUserDataString, getUserMap, isUserDataEmpty, putCopyableUserData, putUserData, putUserDataIfAbsent, replace, setUserMap

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.psi.PsiElement

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, getTextLength, getTextOffset, getTextRange, getTextRangeInParent, getUseScope, isEquivalentTo, isPhysical, isValid, isWritable, processDeclarations, putCopyableUserData, replace, textContains, textMatches, textMatches, textToCharArray

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

hasAnnotation

Constructor Detail

LightModifierList

public LightModifierList(PsiModifierListOwner modifierListOwner)

LightModifierList

public LightModifierList(PsiManager manager)

LightModifierList

public LightModifierList(PsiManager manager,
                         Language language,
                         java.lang.String... modifiers)

Method Detail

addModifier

public void addModifier(java.lang.String modifier)

copyModifiers

public void copyModifiers(PsiModifierList modifierList)

clearModifiers

public void clearModifiers()

hasModifierProperty

public boolean hasModifierProperty(java.lang.String name)

Description copied from interface: PsiModifierList

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

Specified by:

hasModifierProperty in interface PsiModifierList

Parameters:

name - the name of the modifier to check.

Returns:

true if the list has the modifier, false otherwise

See Also:

PsiModifierList.hasExplicitModifier(String)

hasExplicitModifier

public boolean hasExplicitModifier(java.lang.String name)

Description copied from interface: PsiModifierList

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

Specified by:

hasExplicitModifier in interface PsiModifierList

Parameters:

name - the name of the modifier to check.

Returns:

true if the list has the modifier, false otherwise

See Also:

PsiModifierList.hasModifierProperty(String)

setModifierProperty

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

Description copied from interface: PsiModifierList

Adds or removes the specified modifier to the modifier list.

Specified by:

setModifierProperty in interface PsiModifierList

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

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

Description copied from interface: PsiModifierList

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.

Specified by:

checkSetModifierProperty in interface PsiModifierList

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.

getAnnotations

public PsiAnnotation [] getAnnotations()

Description copied from interface: PsiAnnotationOwner

Returns the list of annotations syntactically contained in the element.

Specified by:

getAnnotations in interface PsiAnnotationOwner

Returns:

the list of annotations.

getApplicableAnnotations

public PsiAnnotation [] getApplicableAnnotations()

Specified by:

getApplicableAnnotations in interface PsiAnnotationOwner

Returns:

the list of annotations which are applicable to this owner (e.g. type annotations on method belong to its type element, not the method).

findAnnotation

public PsiAnnotation findAnnotation(java.lang.String qualifiedName)

Description copied from interface: PsiAnnotationOwner

Searches the owner for an annotation with the specified fully qualified name and returns one if it is found.

Specified by:

findAnnotation in interface PsiAnnotationOwner

Parameters:

qualifiedName - the fully qualified name of the annotation to find.

Returns:

the annotation instance, or null if no such annotation is found.

addAnnotation

public PsiAnnotation addAnnotation(java.lang.String qualifiedName)

Description copied from interface: PsiAnnotationOwner

Adds a new annotation to this owner. The annotation class name will be shortened. No attributes will be defined.

Specified by:

addAnnotation in interface PsiAnnotationOwner

Parameters:

qualifiedName - qualifiedName

Returns:

newly added annotation

accept

public void accept(PsiElementVisitor visitor)

Description copied from interface: PsiElement

Passes the element to the specified visitor.

Specified by:

accept in interface PsiElement

Overrides:

accept in class LightElement

Parameters:

visitor - the visitor to pass the element to.

toString

public java.lang.String toString()

Description copied from interface: PsiElement

toString() should never be presented to the user.

Specified by:

toString in interface PsiElement

Specified by:

toString in class LightElement

getText

public java.lang.String getText()

Description copied from interface: PsiElement

Returns the text of the PSI element.

Note: This call requires traversing whole subtree, so it can be expensive for composite elements, and should be avoided if possible.

Specified by:

getText in interface PsiElement

Overrides:

getText in class LightElement

Returns:

the element text.

See Also:

PsiElement.textMatches(java.lang.CharSequence), PsiElement.textContains(char)

getModifiers

public java.lang.String [] getModifiers()