Package com.intellij.codeInsight

Enum Nullability

java.lang.Object

java.lang.Enum<Nullability>

com.intellij.codeInsight.Nullability

All Implemented Interfaces:

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

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

Represents a nullability (ability to hold, accept or return null) for variables, fields, method parameters, method return values, type parameters and type arguments.

Enum Constant Summary

Enum Constants

Enum Constant and Description
NOT_NULL Value which cannot hold null; method which cannot return null; parameter which cannot accept null
NULLABLE Value which holds null; method which can return null; parameter which accepts null
UNKNOWN Nullability is not yet defined or "weak nullability" (e.g.

Method Summary

Modifier and Type	Method and Description
static Nullability	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Nullability[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NOT_NULL

public static final Nullability NOT_NULL

Value which cannot hold null; method which cannot return null; parameter which cannot accept null

NULLABLE

public static final Nullability NULLABLE

Value which holds null; method which can return null; parameter which accepts null

UNKNOWN

public static final Nullability UNKNOWN

Nullability is not yet defined or "weak nullability" (e.g. method may return null, but often it can be determined in some other way whether null is possible here, so null-check is not strictly necessary).

Method Detail

values

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

Returns:

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

valueOf

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