net.markenwerk.commons.collections

Enum Nullity

java.lang.Object

java.lang.Enum<Nullity>

net.markenwerk.commons.collections.Nullity

All Implemented Interfaces:

Serializable, Comparable<Nullity>

public enum Nullity
extends Enum<Nullity>

A Nullity indicates the intended handling of null values that are added to a data structure.

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALLOW A null should be allowed.
IGNORE A null should be ignored.
REJECT A null should be rejected.

Field Summary

Fields

Modifier and Type	Field and Description
static int	NO_POSITION Constant to indicate, that a null doesn't originate from an array or Iterable.

Method Summary

Modifier and Type	Method and Description
abstract boolean	proceedAdd(String what, int position) Returns whether to allow adding a null value to a data structure.
abstract boolean	proceedReplace(String what, int position) Returns whether to allow replacing a non-null value with a null value.
static Nullity	valueOf(String name) Returns the enum constant of this type with the specified name.
static Nullity[]	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

ALLOW

public static final Nullity ALLOW

A null should be allowed. It can be inserted and can be used to replace another value.

IGNORE

public static final Nullity IGNORE

A null should be ignored. It won't be inserted and can't be used to replace another value.

REJECT

public static final Nullity REJECT

A null should be rejected. It can't be inserted and can't be used to replace another value.

Field Detail

NO_POSITION

public static final int NO_POSITION

Constant to indicate, that a null doesn't originate from an array or Iterable.

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

public static Nullity valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

proceedAdd

public abstract boolean proceedAdd(String what,
                                   int position)
                            throws IllegalArgumentException

Returns whether to allow adding a null value to a data structure.

Parameters:

what - Textual representation of the kind of The position of the null value to be used in an appropriate exception message.

position - The position of the null value inside of an array or Iterable that is added to the data structure, or NO_POSITION.

Returns:

Whether to allow the intended operation.

Throws:

IllegalArgumentException - If adding a null value to a data structure is considered to be a failure.

proceedReplace

public abstract boolean proceedReplace(String what,
                                       int position)
                                throws IllegalArgumentException

Returns whether to allow replacing a non-null value with a null value.

Parameters:

what - Textual representation of the kind of The position of the null value to be used in an appropriate exception message.

position - The position of the null value inside of an array or Iterable that is added to the data structure, or NO_POSITION.

Returns:

Whether to allow the intended operation.

Throws:

IllegalArgumentException - If adding a null value to a data structure is considered to be a failure.