Package com.intellij.codeInsight

Class NullableNotNullManager

java.lang.Object

com.intellij.codeInsight.NullableNotNullManager

Direct Known Subclasses:

NullableNotNullManagerImpl

public abstract class NullableNotNullManager
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected static Logger	LOG
protected Project	myProject

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NullableNotNullManager(Project project)

Method Summary

Modifier and Type	Method and Description
PsiAnnotation	copyNotNullAnnotation(PsiModifierListOwner owner) Deprecated. use copyNotNullAnnotation(PsiModifierListOwner, PsiModifierListOwner)
PsiAnnotation	copyNotNullAnnotation(PsiModifierListOwner original, PsiModifierListOwner generated)
PsiAnnotation	copyNullableAnnotation(PsiModifierListOwner original, PsiModifierListOwner generated)
PsiAnnotation	copyNullableOrNotNullAnnotation(PsiModifierListOwner original, PsiModifierListOwner generated)
NullabilityAnnotationInfo	findEffectiveNullabilityInfo(PsiModifierListOwner owner) Returns nullability annotation info which has effect for given element.
NullabilityAnnotationInfo	findExplicitNullability(PsiModifierListOwner owner) Returns information about explicit nullability annotation (without looking into external/inferred annotations, but looking into container annotations).
PsiAnnotation	findExplicitNullabilityAnnotation(PsiModifierListOwner owner, Nullability nullability)
NullabilityAnnotationInfo	findOwnNullabilityInfo(PsiModifierListOwner owner) Returns own nullability annotation info for given element.
protected java.util.Set<java.lang.String>	getAllNullabilityAnnotationsWithNickNames()
abstract java.lang.String	getDefaultNotNull()
abstract java.lang.String	getDefaultNullable()
static NullableNotNullManager	getInstance(Project project)
abstract java.util.List<java.lang.String>	getInstrumentedNotNulls()
PsiAnnotation	getNotNullAnnotation(PsiModifierListOwner owner, boolean checkBases) Returns an annotation which marks given element as NotNull, if any.
abstract java.util.List<java.lang.String>	getNotNulls()
protected java.util.List<java.lang.String>	getNotNullsWithNickNames()
static Nullability	getNullability(PsiModifierListOwner owner) Returns nullability of given element defined by annotations.
PsiAnnotation	getNullableAnnotation(PsiModifierListOwner owner, boolean checkBases) Returns an annotation which marks given element as Nullable, if any.
abstract java.util.List<java.lang.String>	getNullables()
protected java.util.List<java.lang.String>	getNullablesWithNickNames()
protected boolean	hasHardcodedContracts(PsiElement element)
boolean	hasNullability(PsiModifierListOwner owner)
static boolean	isNotNull(PsiModifierListOwner owner) Returns true if given element is known to be non-nullable
boolean	isNotNull(PsiModifierListOwner owner, boolean checkBases)
static boolean	isNullabilityAnnotation(PsiAnnotation annotation) Checks if given annotation specifies the nullability (either nullable or not-null)
static boolean	isNullable(PsiModifierListOwner owner) Returns true if given element is known to be nullable
boolean	isNullable(PsiModifierListOwner owner, boolean checkBases)
abstract void	setDefaultNotNull(java.lang.String defaultNotNull)
abstract void	setDefaultNullable(java.lang.String defaultNullable)
abstract void	setInstrumentedNotNulls(java.util.List<java.lang.String> names)
abstract void	setNotNulls(java.lang.String... annotations)
abstract void	setNullables(java.lang.String... annotations)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

protected static final Logger LOG

myProject

protected final Project myProject

Constructor Detail

NullableNotNullManager

protected NullableNotNullManager(Project project)

Method Detail

getInstance

public static NullableNotNullManager getInstance(Project project)

hasNullability

public boolean hasNullability(PsiModifierListOwner owner)

Returns:

if owner has a @NotNull or @Nullable annotation, or is in scope of @ParametersAreNullableByDefault or ParametersAreNonnullByDefault

setNotNulls

public abstract void setNotNulls(java.lang.String... annotations)

setNullables

public abstract void setNullables(java.lang.String... annotations)

getDefaultNullable

public abstract java.lang.String getDefaultNullable()

getNullableAnnotation

public PsiAnnotation getNullableAnnotation(PsiModifierListOwner owner,
                                           boolean checkBases)

Returns an annotation which marks given element as Nullable, if any. Usage of this method is discouraged. Use findEffectiveNullabilityInfo(PsiModifierListOwner) instead.

setDefaultNullable

public abstract void setDefaultNullable(java.lang.String defaultNullable)

getDefaultNotNull

public abstract java.lang.String getDefaultNotNull()

getNotNullAnnotation

public PsiAnnotation getNotNullAnnotation(PsiModifierListOwner owner,
                                          boolean checkBases)

Returns an annotation which marks given element as NotNull, if any. Usage of this method is discouraged. Use findEffectiveNullabilityInfo(PsiModifierListOwner) instead.

copyNotNullAnnotation

public PsiAnnotation copyNotNullAnnotation(PsiModifierListOwner original,
                                           PsiModifierListOwner generated)

copyNullableAnnotation

public PsiAnnotation copyNullableAnnotation(PsiModifierListOwner original,
                                            PsiModifierListOwner generated)

copyNullableOrNotNullAnnotation

public PsiAnnotation copyNullableOrNotNullAnnotation(PsiModifierListOwner original,
                                                     PsiModifierListOwner generated)

copyNotNullAnnotation

@Deprecated
public PsiAnnotation copyNotNullAnnotation(PsiModifierListOwner owner)

Deprecated. use copyNotNullAnnotation(PsiModifierListOwner, PsiModifierListOwner)

setDefaultNotNull

public abstract void setDefaultNotNull(java.lang.String defaultNotNull)

findOwnNullabilityInfo

public NullabilityAnnotationInfo findOwnNullabilityInfo(PsiModifierListOwner owner)

Returns own nullability annotation info for given element. Returned annotation is not inherited and not container annotation for class/package. Still it could be inferred or external.

Parameters:

owner - element to find a nullability info for

Returns:

own nullability annotation info.

findExplicitNullability

public NullabilityAnnotationInfo findExplicitNullability(PsiModifierListOwner owner)

Returns information about explicit nullability annotation (without looking into external/inferred annotations, but looking into container annotations). This method is rarely useful in client code, it's designed mostly to aid the inference procedure.

Parameters:

owner - element to get the info about

Returns:

the annotation info or null if no explicit annotation found

findEffectiveNullabilityInfo

public NullabilityAnnotationInfo findEffectiveNullabilityInfo(PsiModifierListOwner owner)

Returns nullability annotation info which has effect for given element.

Parameters:

owner - element to find an annotation for

Returns:

effective nullability annotation info, or null if not found.

findExplicitNullabilityAnnotation

public PsiAnnotation findExplicitNullabilityAnnotation(PsiModifierListOwner owner,
                                                       Nullability nullability)

Returns:

an annotation (if any) with the given nullability semantics on the given declaration or its type. In case of conflicts, type annotations are preferred.

getNullablesWithNickNames

protected java.util.List<java.lang.String> getNullablesWithNickNames()

getNotNullsWithNickNames

protected java.util.List<java.lang.String> getNotNullsWithNickNames()

getAllNullabilityAnnotationsWithNickNames

protected java.util.Set<java.lang.String> getAllNullabilityAnnotationsWithNickNames()

hasHardcodedContracts

protected boolean hasHardcodedContracts(PsiElement element)

isNullable

public boolean isNullable(PsiModifierListOwner owner,
                          boolean checkBases)

isNotNull

public boolean isNotNull(PsiModifierListOwner owner,
                         boolean checkBases)

getNullables

public abstract java.util.List<java.lang.String> getNullables()

getNotNulls

public abstract java.util.List<java.lang.String> getNotNulls()

isNullable

public static boolean isNullable(PsiModifierListOwner owner)

Returns true if given element is known to be nullable

Parameters:

owner - element to check

Returns:

true if given element is known to be nullable

isNotNull

public static boolean isNotNull(PsiModifierListOwner owner)

Returns true if given element is known to be non-nullable

Parameters:

owner - element to check

Returns:

true if given element is known to be non-nullable

getNullability

public static Nullability getNullability(PsiModifierListOwner owner)

Returns nullability of given element defined by annotations.

Parameters:

owner - element to find nullability for

Returns:

found nullability; Nullability.UNKNOWN if not specified or non-applicable

getInstrumentedNotNulls

public abstract java.util.List<java.lang.String> getInstrumentedNotNulls()

setInstrumentedNotNulls

public abstract void setInstrumentedNotNulls(java.util.List<java.lang.String> names)

isNullabilityAnnotation

public static boolean isNullabilityAnnotation(PsiAnnotation annotation)

Checks if given annotation specifies the nullability (either nullable or not-null)

Parameters:

annotation - annotation to check

Returns:

true if given annotation specifies nullability