org.josef.jpa

Enum PersistAction

java.lang.Object

java.lang.Enum<PersistAction>

org.josef.jpa.PersistAction

All Implemented Interfaces:

Serializable, Comparable<PersistAction>

@Status(stage=PRODUCTION,
        unitTests=COMPLETE)
 @Review(by="Kees Schotanus",
        at="2009-09-28")
public enum PersistAction
extends Enum<PersistAction>

Enumeration of actions that can be performed on persistable entities.

Version:

1.0 $Revision: 6488 $

Author:

Kees Schotanus

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXECUTE_NAMED_QUERY Execute a named query.
FIND_ALL Find all.
FIND_BY_CRITERIA Find by criteria.
FIND_BY_OBJECT_ID Find by Object ID.
MERGE Merge.
PERSIST Persist.
REMOVE Delete.

Method Summary

Modifier and Type	Method and Description
String	toNonLocalizedString() Creates a non localized String representation of this PersistAction.
static PersistAction	valueOf(String name) Returns the enum constant of this type with the specified name.
static PersistAction[]	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

PERSIST

public static final PersistAction PERSIST

Persist.

MERGE

public static final PersistAction MERGE

Merge.

REMOVE

public static final PersistAction REMOVE

Delete.

FIND_BY_CRITERIA

public static final PersistAction FIND_BY_CRITERIA

Find by criteria.

FIND_BY_OBJECT_ID

public static final PersistAction FIND_BY_OBJECT_ID

Find by Object ID.

FIND_ALL

public static final PersistAction FIND_ALL

Find all.

EXECUTE_NAMED_QUERY

public static final PersistAction EXECUTE_NAMED_QUERY

Execute a named query.

Method Detail

values

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

Returns:

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

valueOf

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

toNonLocalizedString

public String toNonLocalizedString()

Creates a non localized String representation of this PersistAction.
Note: Overriding toString() for this purpose would prevent this enum from being used in JSF select items, since it depends on toString() to return the actual name of the enumerated constant.

Returns:

A non localized String representation of this PersistAction.