MDS/openide
1
0
Fork 0
mirror of https://gitflic.ru/project/openide/openide.git synced 2026-09-27 10:03:11 +07:00
Code Issues Packages Projects Releases Wiki Activity

Mutability JavaDoc

Browse Source
This commit is contained in:
Tagir Valeev
2018-03-12 10:18:11 +07:00
parent 7ecb32ce2b
commit ba7fc695b3
1 changed files with 28 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
java/java-analysis-impl/src/com/intellij/codeInspection/dataFlow/Mutability.java
+28 -1
View File
@@ -13,7 +13,25 @@ import org.jetbrains.annotations.NotNull;
import java.util.Collections;
public enum Mutability {
UNKNOWN, MUTABLE, UNMODIFIABLE, UNMODIFIABLE_VIEW;
/**
* Mutability is not known; probably value can be mutated
*/
UNKNOWN,
/**
* A value is known to be mutable (e.g. elements are sometimes added to the collection)
*/
MUTABLE,
/**
* 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).
*/
UNMODIFIABLE,
/**
* 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. {@link java.util.Collection#size}) may return different results if the
* underlying value is mutated by somebody else.
*/
UNMODIFIABLE_VIEW;
public static final String UNMODIFIABLE_ANNOTATION = "org.jetbrains.annotations.Unmodifiable";
public static final String UNMODIFIABLE_VIEW_ANNOTATION = "org.jetbrains.annotations.UnmodifiableView";
@@ -22,6 +40,15 @@ public enum Mutability {
return this == UNMODIFIABLE || this == UNMODIFIABLE_VIEW;
}
/**
* 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).
*
* @param owner an element to check the mutability
* @return a Mutability enum value; {@link #UNKNOWN} if cannot be determined or specified element type is not supported.
*/
@NotNull
public static Mutability getMutability(@NotNull PsiModifierListOwner owner) {
if (owner instanceof PsiParameter && owner.getParent() instanceof PsiParameterList) {