Package com.intellij.psi.impl.light

Class LightRecordField

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

com.intellij.psi.impl.light.LightRecordField

All Implemented Interfaces:

JvmAnnotatedElement, JvmElement, JvmField, JvmMember, JvmModifiersOwner, JvmNamedElement, NavigationItem, Iconable, UserDataHolder, UserDataHolderEx, Navigatable, PomNamedTarget, PomRenameableTarget<PsiElement>, PomTarget, LightRecordMember, NavigatablePsiElement, PsiDocCommentOwner, PsiElement, PsiField, PsiJavaDocumentedElement, PsiJvmMember, PsiJvmModifiersOwner, PsiMember, PsiModifierListOwner, PsiNamedElement, PsiNameIdentifierOwner, PsiTarget, PsiVariable, SyntheticElement, java.lang.Cloneable

public class LightRecordField
extends LightField
implements LightRecordMember

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

ARRAY_FACTORY, EMPTY_ARRAY

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
LightRecordField(PsiManager manager, PsiField field, PsiClass containingClass, PsiRecordComponent component)

Method Summary

Modifier and Type	Method and Description
PsiAnnotation	getAnnotation(java.lang.String fqn)
PsiAnnotation []	getAnnotations()
PsiFile	getContainingFile() Returns the file containing the PSI element.
PsiElement	getContext() Returns the element which should be used as the parent of this element in a tree up walk during a resolve operation.
javax.swing.Icon	getElementIcon(int flags)
PsiElement	getNavigationElement() Returns the PSI element which should be used as a navigation target when navigation to this PSI element is requested.
PsiRecordComponent	getRecordComponent()
int	getTextOffset() Returns the offset in the file to which the caret should be placed when performing the navigation to the element.
PsiType	getType() Returns the type of the variable.
SearchScope	getUseScope() Returns the scope in which references to this element are searched.
boolean	hasAnnotation(java.lang.String fqn)
boolean	isWritable() Checks if the contents of the element can be modified (if it belongs to a non-read-only source file.)

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

computeConstantValue, copy, getContainingClass, getDocComment, getInitializer, getModifierList, getName, getNameIdentifier, getText, getTextRange, getTypeElement, hasInitializer, hasModifierProperty, isDeprecated, isEquivalentTo, isValid, normalizeDeclaration, setInitializer, setName, toString

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

accept, add, addAfter, addBefore, checkAdd, checkDelete, delete, findElementAt, getChildren, getLanguage, getManager, getNextSibling, getNode, getParent, getPrevSibling, getStartOffsetInParent, getTextLength, isPhysical, 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, getFirstChild, getLastChild, getOriginalElement, getPresentation, getProject, getReference, getReferences, getResolveScope, navigate, notNullChild, processDeclarations, textContains

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

buildRowIcon, computeBaseIcon, createLayeredIcon, getAdjustedBaseIcon, getBaseIcon, 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

accept, acceptChildren, add, addAfter, addBefore, addRange, addRangeAfter, addRangeBefore, checkAdd, checkDelete, copy, delete, deleteChildRange, findElementAt, findReferenceAt, getChildren, getCopyableUserData, getFirstChild, getLanguage, getLastChild, getManager, getNextSibling, getNode, getOriginalElement, getOwnReferences, getParent, getPrevSibling, getProject, getReference, getReferences, getResolveScope, getStartOffsetInParent, getText, getTextLength, getTextRange, getTextRangeInParent, isEquivalentTo, isPhysical, isValid, 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.PsiJvmModifiersOwner

getSourceElement, hasModifier

Methods inherited from interface com.intellij.psi.PsiNameIdentifierOwner

getIdentifyingElement

Methods inherited from interface com.intellij.navigation.NavigationItem

getPresentation

Methods inherited from interface com.intellij.pom.Navigatable

canNavigate, canNavigateToSource, navigate

Methods inherited from interface com.intellij.lang.jvm.JvmField

accept

Constructor Detail

LightRecordField

public LightRecordField(PsiManager manager,
                        PsiField field,
                        PsiClass containingClass,
                        PsiRecordComponent component)

Method Detail

getRecordComponent

public PsiRecordComponent getRecordComponent()

Specified by:

getRecordComponent in interface LightRecordMember

getTextOffset

public int getTextOffset()

Description copied from interface: PsiElement

Returns the offset in the file to which the caret should be placed when performing the navigation to the element. (For classes implementing PsiNamedElement, this should return the offset in the file of the name identifier.)

Specified by:

getTextOffset in interface PsiElement

Overrides:

getTextOffset in class LightElement

Returns:

the offset of the PSI element.

getNavigationElement

public PsiElement getNavigationElement()

Description copied from interface: PsiElement

Returns the PSI element which should be used as a navigation target when navigation to this PSI element is requested. The method can either return this or substitute a different element if this element does not have an associated file and offset. (For example, if the source code of a library is attached to a project, the navigation element for a compiled library class is its source class.)

Specified by:

getNavigationElement in interface PsiElement

Specified by:

getNavigationElement in interface PsiTarget

Overrides:

getNavigationElement in class LightElement

Returns:

the navigation target element.

isWritable

public boolean isWritable()

Description copied from interface: PsiElement

Checks if the contents of the element can be modified (if it belongs to a non-read-only source file.)

Specified by:

isWritable in interface PomRenameableTarget<PsiElement>

Specified by:

isWritable in interface PsiElement

Overrides:

isWritable in class LightElement

Returns:

true if the element can be modified, false otherwise.

getContainingFile

public PsiFile getContainingFile()

Description copied from interface: PsiElement

Returns the file containing the PSI element.

Note: this method might need to traverse the whole AST up, which can be slow in deep trees, so invoking this method should be avoided if possible.

Specified by:

getContainingFile in interface PsiElement

Overrides:

getContainingFile in class LightElement

Returns:

the file instance, or null if the PSI element is not contained in a file (for example, the element represents a package or directory).

getType

public PsiType getType()

Description copied from interface: PsiVariable

Returns the type of the variable.

Specified by:

getType in interface JvmField

Specified by:

getType in interface PsiField

Specified by:

getType in interface PsiVariable

Overrides:

getType in class LightField

Returns:

the variable type.

See Also:

Field.getGenericType(), Field.getAnnotatedType()

getAnnotations

public PsiAnnotation [] getAnnotations()

Specified by:

getAnnotations in interface JvmAnnotatedElement

Specified by:

getAnnotations in interface PsiJvmModifiersOwner

Specified by:

getAnnotations in interface PsiModifierListOwner

hasAnnotation

public boolean hasAnnotation(java.lang.String fqn)

Specified by:

hasAnnotation in interface JvmAnnotatedElement

Specified by:

hasAnnotation in interface PsiJvmModifiersOwner

Specified by:

hasAnnotation in interface PsiModifierListOwner

getAnnotation

public PsiAnnotation getAnnotation(java.lang.String fqn)

Specified by:

getAnnotation in interface JvmAnnotatedElement

Specified by:

getAnnotation in interface PsiJvmModifiersOwner

Specified by:

getAnnotation in interface PsiModifierListOwner

getElementIcon

public javax.swing.Icon getElementIcon(int flags)

Overrides:

getElementIcon in class ElementBase

getContext

public PsiElement getContext()

Description copied from interface: PsiElement

Returns the element which should be used as the parent of this element in a tree up walk during a resolve operation. For most elements, this returns getParent(), but the context can be overridden for some elements like code fragments (see JavaCodeFragmentFactory.createCodeBlockCodeFragment(String, PsiElement, boolean)).

Specified by:

getContext in interface PsiElement

Overrides:

getContext in class PsiElementBase

Returns:

the resolve context element.

getUseScope

public SearchScope getUseScope()

Description copied from interface: PsiElement

Returns the scope in which references to this element are searched.

Specified by:

getUseScope in interface PsiElement

Overrides:

getUseScope in class LightField

Returns:

the search scope instance.

See Also:

PsiSearchHelper.getUseScope(PsiElement)