Package com.intellij.codeInspection.dataFlow

Enum Mutability

java.lang.Object

java.lang.Enum<Mutability>

com.intellij.codeInspection.dataFlow.Mutability

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Mutability>

public enum Mutability
extends java.lang.Enum<Mutability>

Enum Constant Summary

Enum Constants

Enum Constant and Description
MUTABLE A value is known to be mutable (e.g.
UNKNOWN Mutability is not known; probably value can be mutated
UNMODIFIABLE A value is known to be immutable.
UNMODIFIABLE_VIEW A value is known to be an immutable view over a possibly mutable value: it cannot be mutated directly using this reference; however subsequent reads (e.g.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	UNMODIFIABLE_ANNOTATION
static java.lang.String	UNMODIFIABLE_VIEW_ANNOTATION

Method Summary

Modifier and Type	Method and Description
PsiAnnotation	asAnnotation(Project project)
DfReferenceType	asDfType()
static Mutability	fromDfType(DfType dfType)
static Mutability	getMutability(PsiModifierListOwner owner) Returns a mutability of the supplied element, if known.
Mutability	intersect(Mutability other)
boolean	isUnmodifiable()
java.lang.String	toString()
Mutability	unite(Mutability other)
static Mutability	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Mutability[]	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

Enum Constant Detail

UNKNOWN

public static final Mutability UNKNOWN

Mutability is not known; probably value can be mutated

MUTABLE

public static final Mutability MUTABLE

A value is known to be mutable (e.g. elements are sometimes added to the collection)

UNMODIFIABLE_VIEW

public static final Mutability UNMODIFIABLE_VIEW

A value is known to be an immutable view over a possibly mutable value: it cannot be mutated directly using this reference; however subsequent reads (e.g. Collection.size()) may return different results if the underlying value is mutated by somebody else.

UNMODIFIABLE

public static final Mutability UNMODIFIABLE

A value is known to be immutable. For collection no elements could be added, removed or altered (though if collection contains mutable elements, they still could be mutated).

Field Detail

UNMODIFIABLE_ANNOTATION

public static final java.lang.String UNMODIFIABLE_ANNOTATION

UNMODIFIABLE_VIEW_ANNOTATION

public static final java.lang.String UNMODIFIABLE_VIEW_ANNOTATION

Method Detail

values

public static Mutability[] 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 (Mutability c : Mutability.values())
    System.out.println(c);

Returns:

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

valueOf

public static Mutability 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

asDfType

public DfReferenceType asDfType()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<Mutability>

isUnmodifiable

public boolean isUnmodifiable()

unite

public Mutability unite(Mutability other)

intersect

public Mutability intersect(Mutability other)

asAnnotation

public PsiAnnotation asAnnotation(Project project)

getMutability

public static Mutability getMutability(PsiModifierListOwner owner)

Returns a mutability of the supplied element, if known. The element could be a method (in this case the return value mutability is returned), a method parameter (the returned mutability will reflect whether the method can mutate the parameter), or a field (in this case the mutability could be obtained from its initializer).

Parameters:

owner - an element to check the mutability

Returns:

a Mutability enum value; UNKNOWN if cannot be determined or specified element type is not supported.

fromDfType

public static Mutability fromDfType(DfType dfType)