Package com.intellij.codeInspection.reference

Interface RefParameter

All Superinterfaces:

RefElement, RefEntity, RefJavaElement, UserDataHolder

All Known Implementing Classes:

RefParameterImpl

public interface RefParameter
extends RefJavaElement

A node in the reference graph corresponding to a Java method parameter.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Object	VALUE_IS_NOT_CONST
static java.lang.Object	VALUE_UNDEFINED

Fields inherited from interface com.intellij.codeInspection.reference.RefEntity

EMPTY_ELEMENTS_ARRAY

Method Summary

Modifier and Type	Method and Description
default java.lang.Object	getActualConstValue() If all invocations of the method pass the same value to the parameter, returns that value (the name of a static final field or the text of a literal expression).
default java.lang.String	getActualValueIfSame() Deprecated.
default PsiParameter	getElement() Deprecated.
int	getIndex() Returns the index of the parameter in the parameter list of its owner method.
default UParameter	getUastElement()
default int	getUsageCount()
boolean	isUsedForReading() Checks if the parameter is used for reading.
boolean	isUsedForWriting() Checks if the parameter is used for writing.
void	parameterReferenced(boolean forWriting) Marks the parameter as referenced for reading or writing.

Methods inherited from interface com.intellij.codeInspection.reference.RefJavaElement

getAccessModifier, getOutTypeReferences, getPsiElement, isFinal, isStatic, isSyntheticJSP

Methods inherited from interface com.intellij.codeInspection.reference.RefElement

getContainingEntry, getInReferences, getModule, getOutReferences, getPointer, isEntry, isPermanentEntry, isReachable, isReferenced

Methods inherited from interface com.intellij.codeInspection.reference.RefEntity

accept, getChildren, getExternalName, getIcon, getName, getOwner, getQualifiedName, getRefManager, isValid

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

getUserData, putUserData

Field Detail

VALUE_IS_NOT_CONST

static final java.lang.Object VALUE_IS_NOT_CONST

VALUE_UNDEFINED

static final java.lang.Object VALUE_UNDEFINED

Method Detail

isUsedForReading

boolean isUsedForReading()

Checks if the parameter is used for reading.

Returns:

true if the parameter has read accesses, false otherwise.

isUsedForWriting

boolean isUsedForWriting()

Checks if the parameter is used for writing.

Returns:

true if the parameter has write accesses, false otherwise.

getIndex

int getIndex()

Returns the index of the parameter in the parameter list of its owner method.

Returns:

the index of the parameter.

getActualValueIfSame

@Deprecated
default java.lang.String getActualValueIfSame()

Deprecated.

See Also:

getActualConstValue()

getActualConstValue

default java.lang.Object getActualConstValue()

If all invocations of the method pass the same value to the parameter, returns that value (the name of a static final field or the text of a literal expression). Otherwise, returns VALUE_IS_NOT_CONST.

Returns:

the parameter value or null if it's different or impossible to determine.

parameterReferenced

void parameterReferenced(boolean forWriting)

Marks the parameter as referenced for reading or writing.

Parameters:

forWriting - true if the parameter is marked as referenced for writing, false otherwise.

getUastElement

default UParameter getUastElement()

Specified by:

getUastElement in interface RefJavaElement

getElement

@Deprecated
default PsiParameter getElement()

Deprecated.

Specified by:

getElement in interface RefElement

Specified by:

getElement in interface RefJavaElement

getUsageCount

default int getUsageCount()