com.idevicesinc.sweetblue.annotations

Enum Nullable.Prevalence

java.lang.Object

java.lang.Enum<Nullable.Prevalence>

com.idevicesinc.sweetblue.annotations.Nullable.Prevalence

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Nullable.Prevalence>

Enclosing class:

Nullable

public static enum Nullable.Prevalence
extends java.lang.Enum<Nullable.Prevalence>

Generally used for ElementType.METHOD to hint at how often it should return null.

Enum Constant Summary

Enum Constants

Enum Constant and Description
NEVER For method return values, returning null will never happen.
NORMAL For method return values, returning null is a part of normal program execution.
RARE For method return values, returning null is a rare occurrence that may signify some deeper issue.

Method Summary

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

NORMAL

public static final Nullable.Prevalence NORMAL

For method return values, returning null is a part of normal program execution.

For method input parameters, passing null is normal and expected.

RARE

public static final Nullable.Prevalence RARE

For method return values, returning null is a rare occurrence that may signify some deeper issue.

For method input parameters, passing null is handled as a defensive measure but is rarely expected, and may signify some deeper issue upstream. An assertion may be thrown and unit tests may fail, but an Exception won't be thrown for program integrity's sake.

NEVER

public static final Nullable.Prevalence NEVER

For method return values, returning null will never happen.

For method input parameters, passing null is not allowed and may result in an Exception.

Method Detail

values

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

Returns:

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

valueOf

public static Nullable.Prevalence 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