org.omnifaces.persistence.model

Enum SoftDeletable.Type

java.lang.Object

java.lang.Enum<SoftDeletable.Type>

org.omnifaces.persistence.model.SoftDeletable.Type

All Implemented Interfaces:

Serializable, Comparable<SoftDeletable.Type>

Enclosing class:

SoftDeletable

public static enum SoftDeletable.Type
extends Enum<SoftDeletable.Type>

Defines the types of the soft delete column.

Author:

Sergey Kuntsel

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACTIVE Indicates that the associated column is a column holding active state.
DELETED Indicates that the associated column is a column holding deleted state.

Method Summary

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

DELETED

public static final SoftDeletable.Type DELETED

Indicates that the associated column is a column holding deleted state. All entities that haven't been soft deleted will thus have false in the soft delete column, assuming it was mapped as boolean. This is the default type.

ACTIVE

public static final SoftDeletable.Type ACTIVE

Indicates that the associated column is a column holding active state. All entities that haven't been soft deleted will thus have true in the soft delete column, assuming it was mapped as boolean.

Method Detail

values

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

Returns:

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

valueOf

public static SoftDeletable.Type 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