com.tangosol.util

Enum RegistrationBehavior

java.lang.Object

java.lang.Enum<RegistrationBehavior>

com.tangosol.util.RegistrationBehavior

All Implemented Interfaces:

Serializable, Comparable<RegistrationBehavior>

public enum RegistrationBehavior
extends Enum<RegistrationBehavior>

A RegistrationBehavior is used by numerous registries for the purpose of specifying the required behavior when registering an artifact.

Since:

Coherence 12.1.2

Author:

bo 2012.10

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALWAYS Specifies that registration must always occur.
FAIL Specifies that registration should fail (by raising an exception) if the identified artifact is already registered.
IGNORE Specifies that registration should be ignored and skipped (without raising an error or exception) if the artifact to be registered is already known.
REPLACE Specifies that registration should replace an existing identified artifact with that of which was specified.

Method Summary

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

IGNORE

public static final RegistrationBehavior IGNORE

Specifies that registration should be ignored and skipped (without raising an error or exception) if the artifact to be registered is already known.

REPLACE

public static final RegistrationBehavior REPLACE

Specifies that registration should replace an existing identified artifact with that of which was specified.

FAIL

public static final RegistrationBehavior FAIL

Specifies that registration should fail (by raising an exception) if the identified artifact is already registered.

ALWAYS

public static final RegistrationBehavior ALWAYS

Specifies that registration must always occur. If an identifiable artifact is already registered, a new identity is generated (based on the provided identity) and the specified artifact is registered.

Method Detail

values

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

Returns:

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

valueOf

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