org.kuali.rice.krad.data.metadata

Enum MetadataMergeAction

java.lang.Object

java.lang.Enum<MetadataMergeAction>

org.kuali.rice.krad.data.metadata.MetadataMergeAction

All Implemented Interfaces:

Serializable, Comparable<MetadataMergeAction>

public enum MetadataMergeAction
extends Enum<MetadataMergeAction>

A component of MetadataCommon which specifies what to do when a duplicate data object, attribute, collection or reference is encountered during the merging performed by the CompositeMetadataProvider.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Enum Constant Summary

Enum Constants

Enum Constant and Description
MERGE The default behavior.
NO_OVERRIDE If a match is found (same data object or attribute name), the existing object will be left alone.
REMOVE If a match is found (same data object or attribute name), the existing object will be removed.
REPLACE If a match is found (same data object or attribute name), the existing object will be replaced completely by this one.

Method Summary

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

MERGE

public static final MetadataMergeAction MERGE

The default behavior. Unset attributes will be left alone.

REPLACE

public static final MetadataMergeAction REPLACE

If a match is found (same data object or attribute name), the existing object will be replaced completely by this one.

REMOVE

public static final MetadataMergeAction REMOVE

If a match is found (same data object or attribute name), the existing object will be removed. (Any attribute except that forming the key (type or attribute name) can be left unset.)

NO_OVERRIDE

public static final MetadataMergeAction NO_OVERRIDE

If a match is found (same data object or attribute name), the existing object will be left alone. The metadata object will only be included if there is not already an existing object.

Method Detail

values

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

Returns:

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

valueOf

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