Package org.hibernate.annotations

Enum SoftDeleteType

java.lang.Object

java.lang.Enum<SoftDeleteType>

org.hibernate.annotations.SoftDeleteType

All Implemented Interfaces:

Serializable, Comparable<SoftDeleteType>

public enum SoftDeleteType
extends Enum<SoftDeleteType>

Enumeration of defines styles of soft-delete

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACTIVE	Tracks rows which are active.
DELETED	Tracks rows which are deleted.

Method Summary

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

ACTIVE

public static final SoftDeleteType ACTIVE

Tracks rows which are active. The values stored in the database:

true

indicates that the row is active (non-deleted)

false

indicates that the row is inactive (deleted)

Implementation Note:

Causes the conversion to be wrapped in a negation.

DELETED

public static final SoftDeleteType DELETED

Tracks rows which are deleted. The values stored in the database:

true

indicates that the row is deleted

false

indicates that the row is non-deleted

Method Detail

values

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

Returns:

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

valueOf

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

getDefaultColumnName

public String getDefaultColumnName()