Package com.intellij.codeInspection.dataFlow.value

Interface VariableDescriptor

All Known Implementing Classes:

DfaExpressionFactory.ArrayElementDescriptor, DfaExpressionFactory.AssertionDisabledDescriptor, DfaExpressionFactory.ThisDescriptor, SpecialField

public interface VariableDescriptor

Represents a descriptor of DfaVariableValue. Two variables are the same if they have the same descriptor and qualifier. A descriptor could be a PsiVariable, getter method, array element with given index, this expression, etc.

Subclasses must have proper Object.equals(Object) and Object.hashCode() implementation or instantiation must be controlled to prevent creating equal objects. Also #toString() must return sane representation of the descriptor.

Method Summary

Modifier and Type	Method and Description
default DfaValue	createValue(DfaValueFactory factory, DfaValue qualifier) Returns a value which describes the field qualified by given qualifier and described by this descriptor
default DfaValue	createValue(DfaValueFactory factory, DfaValue qualifier, boolean forAccessor) Returns a value which describes the field qualified by given qualifier and described by this descriptor
default PsiModifierListOwner	getPsiElement()
PsiType	getType(DfaVariableValue qualifier) Returns the type of the value which is qualified by given qualifier and described by this descriptor
default boolean	isCall()
boolean	isStable()

Method Detail

getPsiElement

default PsiModifierListOwner getPsiElement()

Returns:

a PSI element associated with this descriptor or null if not applicable

isStable

boolean isStable()

Returns:

true if the value stored in this descriptor cannot be changed implicitly (e.g. inside the unknown method call)

isCall

default boolean isCall()

Returns:

true if the value behind this descriptor is a method call which result might be computed from other sources

createValue

default DfaValue createValue(DfaValueFactory factory,
                             DfaValue qualifier)

Returns a value which describes the field qualified by given qualifier and described by this descriptor

Parameters:

factory - factory to use

qualifier - qualifier to use

Returns:

a field value

createValue

default DfaValue createValue(DfaValueFactory factory,
                             DfaValue qualifier,
                             boolean forAccessor)

Returns a value which describes the field qualified by given qualifier and described by this descriptor

Parameters:

factory - factory to use

qualifier - qualifier to use

forAccessor - whether the value is created for accessor result

Returns:

a field value

getType

PsiType getType(DfaVariableValue qualifier)

Returns the type of the value which is qualified by given qualifier and described by this descriptor

Parameters:

qualifier - qualifier (may be null if absent)

Returns:

type of the value