org.compass.annotations
Enum Cascade

java.lang.Object
  extended by java.lang.Enum<Cascade>
      extended by org.compass.annotations.Cascade
All Implemented Interfaces:
Serializable, Comparable<Cascade>

public enum Cascade
extends Enum<Cascade>

Specifies cascading for an object relationship.

Author:
kimchy

Enum Constant Summary
ALL
          Perform cascading for all operations (create, save, delete).
CREATE
          Perform cascading for create operations.
DELETE
          Perform cascading for delete operations.
SAVE
          Perform cascading for save operations.
 
Method Summary
static Cascade valueOf(String name)
          Returns the enum constant of this type with the specified name.
static Cascade[] values()
          Returns an array containing the constants of this enum type, in the order they're declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

ALL

public static final Cascade ALL
Perform cascading for all operations (create, save, delete).


CREATE

public static final Cascade CREATE
Perform cascading for create operations.


SAVE

public static final Cascade SAVE
Perform cascading for save operations.


DELETE

public static final Cascade DELETE
Perform cascading for delete operations.

Method Detail

values

public static final Cascade[] values()
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:
for(Cascade c : Cascade.values())
        System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they're declared

valueOf

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


Copyright (c) 2004-2009 The Compass Project.