oracle.javatools.db.property

Enum Nullable.NullBehaviour

java.lang.Object

java.lang.Enum<Nullable.NullBehaviour>

oracle.javatools.db.property.Nullable.NullBehaviour

All Implemented Interfaces:

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

Enclosing class:

Nullable

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
NOT_NULLABLE Specifies that null is not an allowed value for the property.
NULL_MEANS_FALSE Only valid for Boolean properties that exist in the properties map (i.e.
NULL_MEANS_NOT_SPECIFIED Specifies that null is an allowed value for the property, and it means that the value is not specified.
NULL_MEANS_NOT_SPECIFIED_AND_IGNORE Specifies that null means that the value is not specified, and it should be ignored.
NULLABLE Specifies that null is an allowed and meaningful value for the property.

Method Summary

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

NULLABLE

public static final Nullable.NullBehaviour NULLABLE

Specifies that null is an allowed and meaningful value for the property. On editing, changing the property from having a non-null value to null is meaningful.

NOT_NULLABLE

public static final Nullable.NullBehaviour NOT_NULLABLE

Specifies that null is not an allowed value for the property.

NULL_MEANS_NOT_SPECIFIED

public static final Nullable.NullBehaviour NULL_MEANS_NOT_SPECIFIED

Specifies that null is an allowed value for the property, and it means that the value is not specified. On create of the owning object in a Database the value will be set to a default, so null is not valid for edit.

This is the default state for a property so should never need to be explictly annotated.

NULL_MEANS_NOT_SPECIFIED_AND_IGNORE

public static final Nullable.NullBehaviour NULL_MEANS_NOT_SPECIFIED_AND_IGNORE

Specifies that null means that the value is not specified, and it should be ignored. This should never be set as the value for the Nullable annotation, but a PropertyManager can return it from getNullBehaviour in order to mark properties that cannot be compared between different providers.

See Also:

PropertyManager.getNullBehaviour(oracle.javatools.db.DBObject, oracle.javatools.db.DBObject, java.lang.String)

NULL_MEANS_FALSE

public static final Nullable.NullBehaviour NULL_MEANS_FALSE

Only valid for Boolean properties that exist in the properties map (i.e. are extended properties) and are "flags". It marks a Boolean property as only having two options, null or TRUE.

Method Detail

values

public static Nullable.NullBehaviour[] 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.NullBehaviour c : Nullable.NullBehaviour.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.NullBehaviour 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