edu.internet2.middleware.grouper.misc
Enum SaveMode

java.lang.Object
  extended by java.lang.Enum<SaveMode>
      extended by edu.internet2.middleware.grouper.misc.SaveMode
All Implemented Interfaces:
Serializable, Comparable<SaveMode>

public enum SaveMode
extends Enum<SaveMode>

save mode for static saves. insert only (exception if update), update only (exception on insert), and insert or update doesnt matter.

Author:
mchyzer

Enum Constant Summary
INSERT
          insert only, if exists then exception
INSERT_OR_UPDATE
          it will insert or update depending if exsits or not
UPDATE
          update only, if not exist, then exception
 
Method Summary
abstract  boolean allowedToInsert()
          if allowed to insert
abstract  boolean allowedToUpdate()
          if allowed to update
abstract  boolean isUpdate(String nameToEdit, String name)
          if update based on SaveMode
abstract  void validateNameToEdit(String nameToEdit, String name)
          if there is a uuid, validate it for this
static SaveMode valueOf(String name)
          Returns the enum constant of this type with the specified name.
static SaveMode valueOfIgnoreCase(String string)
          do a case-insensitive matching
static SaveMode[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

INSERT

public static final SaveMode INSERT
insert only, if exists then exception


UPDATE

public static final SaveMode UPDATE
update only, if not exist, then exception


INSERT_OR_UPDATE

public static final SaveMode INSERT_OR_UPDATE
it will insert or update depending if exsits or not

Method Detail

values

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

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

valueOf

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

allowedToUpdate

public abstract boolean allowedToUpdate()
if allowed to update

Returns:
true if allowed to update

isUpdate

public abstract boolean isUpdate(String nameToEdit,
                                 String name)
if update based on SaveMode

Parameters:
nameToEdit -
name -
Returns:
true if this is an update

allowedToInsert

public abstract boolean allowedToInsert()
if allowed to insert

Returns:
true if allowed to insert

validateNameToEdit

public abstract void validateNameToEdit(String nameToEdit,
                                        String name)
if there is a uuid, validate it for this

Parameters:
nameToEdit -
name -

valueOfIgnoreCase

public static SaveMode valueOfIgnoreCase(String string)
do a case-insensitive matching

Parameters:
string -
Returns:
the enum of null or exception if not found