Package com.intellij.codeInspection.dataFlow

Enum SpecialField

java.lang.Object

java.lang.Enum<SpecialField>

com.intellij.codeInspection.dataFlow.SpecialField

All Implemented Interfaces:

VariableDescriptor, java.io.Serializable, java.lang.Comparable<SpecialField>

public enum SpecialField
extends java.lang.Enum<SpecialField>
implements VariableDescriptor

Represents a method which is handled as a field in DFA.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ARRAY_LENGTH
COLLECTION_SIZE
OPTIONAL_VALUE
STRING_LENGTH
UNBOX

Method Summary

Modifier and Type	Method and Description
DfType	asDfType(DfType fieldValue)
DfType	asDfType(DfType fieldValue, PsiType exactResultType)
DfaValue	createValue(DfaValueFactory factory, DfaValue qualifier) Returns a DfaValue which represents this special field
DfaValue	createValue(DfaValueFactory factory, DfaValue qualifier, boolean forAccessor) Returns a value which describes the field qualified by given qualifier and described by this descriptor
static SpecialField	findSpecialField(PsiElement accessor) Finds a special field which corresponds to given accessor (method or field)
DfType	fromConstant(java.lang.Object obj)
static SpecialField	fromQualifier(DfaValue value) Returns a special field which corresponds to given qualifier
static SpecialField	fromQualifierType(PsiType type) Returns a special field which corresponds to given qualifier type (currently it's assumed that only one special field may exist for given qualifier type)
DfType	getDefaultValue(boolean forAccessor) Returns a dfType that describes any possible value this special field may have
MethodContract[]	getEmptyContracts()
MethodContract[]	getEqualsContracts()
DfType	getFromQualifier(DfType dfType) Returns a DfType from given DfType qualifier if it's bound to this special field
java.lang.String	getPresentationText(DfType dfType, PsiType type)
PsiType	getType(DfaVariableValue variableValue) Returns the type of the value which is qualified by given qualifier and described by this descriptor
boolean	isStable()
java.lang.String	toString()
static SpecialField	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SpecialField[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.intellij.codeInspection.dataFlow.value.VariableDescriptor

getPsiElement, isCall

Enum Constant Detail

ARRAY_LENGTH

public static final SpecialField ARRAY_LENGTH

STRING_LENGTH

public static final SpecialField STRING_LENGTH

COLLECTION_SIZE

public static final SpecialField COLLECTION_SIZE

UNBOX

public static final SpecialField UNBOX

OPTIONAL_VALUE

public static final SpecialField OPTIONAL_VALUE

Method Detail

values

public static SpecialField[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SpecialField c : SpecialField.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SpecialField valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

isStable

public boolean isStable()

Specified by:

isStable in interface VariableDescriptor

Returns:

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

getPresentationText

public java.lang.String getPresentationText(DfType dfType,
                                            PsiType type)

findSpecialField

public static SpecialField findSpecialField(PsiElement accessor)

Finds a special field which corresponds to given accessor (method or field)

Parameters:

accessor - accessor to find a special field for

Returns:

found special field or null if accessor cannot be used to access a special field

createValue

public final DfaValue createValue(DfaValueFactory factory,
                                  DfaValue qualifier)

Returns a DfaValue which represents this special field

Specified by:

createValue in interface VariableDescriptor

Parameters:

factory - a factory to create new values if necessary

qualifier - a known qualifier value

Returns:

a DfaValue which represents this special field

createValue

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

Description copied from interface: VariableDescriptor

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

Specified by:

createValue in interface VariableDescriptor

Parameters:

factory - factory to use

qualifier - qualifier to use

forAccessor - whether the value is created for accessor result

Returns:

a field value

getDefaultValue

public DfType getDefaultValue(boolean forAccessor)

Returns a dfType that describes any possible value this special field may have

Parameters:

forAccessor - if true, the default value for accessor result should be returned (may differ from internal representation of value)

Returns:

a dfType for the default value

getType

public PsiType getType(DfaVariableValue variableValue)

Description copied from interface: VariableDescriptor

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

Specified by:

getType in interface VariableDescriptor

Parameters:

variableValue - qualifier (may be null if absent)

Returns:

type of the value

fromConstant

public DfType fromConstant(java.lang.Object obj)

getEmptyContracts

public MethodContract[] getEmptyContracts()

Returns:

a list of method contracts which equivalent to checking this special field for zero

getEqualsContracts

public MethodContract[] getEqualsContracts()

asDfType

public DfType asDfType(DfType fieldValue)

Parameters:

fieldValue - dfType of the special field value

Returns:

a dfType that represents a value having this special field restricted to the supplied dfType

asDfType

public DfType asDfType(DfType fieldValue,
                       PsiType exactResultType)

Parameters:

fieldValue - dfType of the special field value

exactResultType - exact PSI type of the result

Returns:

a dfType that represents a value having this special field restricted to the supplied dfType

getFromQualifier

public DfType getFromQualifier(DfType dfType)

Returns a DfType from given DfType qualifier if it's bound to this special field

Parameters:

dfType - of the qualifier

Returns:

en extracted DfType

fromQualifierType

public static SpecialField fromQualifierType(PsiType type)

Returns a special field which corresponds to given qualifier type (currently it's assumed that only one special field may exist for given qualifier type)

Parameters:

type - a qualifier type

Returns:

a special field; null if no special field is available for given type

fromQualifier

public static SpecialField fromQualifier(DfaValue value)

Returns a special field which corresponds to given qualifier

Parameters:

value - a qualifier value

Returns:

a special field; null if no special field is detected to be related to given qualifier

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<SpecialField>