org.opendaylight.mdsal.eos.common.api

Enum EntityOwnershipState

java.lang.Object

java.lang.Enum<EntityOwnershipState>

org.opendaylight.mdsal.eos.common.api.EntityOwnershipState

All Implemented Interfaces:

Serializable, Comparable<EntityOwnershipState>

public enum EntityOwnershipState
extends Enum<EntityOwnershipState>

Enumerates the current ownership state for an entity.

Author:

Thomas Pantelis

Enum Constant Summary

Enum Constants

Enum Constant and Description
IS_OWNER The local process instance is the owner of the entity.
NO_OWNER The entity has no owner and thus no candidates.
OWNED_BY_OTHER A remote process instance is the owner of the entity.

Method Summary

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

IS_OWNER

public static final EntityOwnershipState IS_OWNER

The local process instance is the owner of the entity.

OWNED_BY_OTHER

public static final EntityOwnershipState OWNED_BY_OTHER

A remote process instance is the owner of the entity.

NO_OWNER

public static final EntityOwnershipState NO_OWNER

The entity has no owner and thus no candidates.

Method Detail

values

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

Returns:

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

valueOf

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

from

public static EntityOwnershipState from(boolean isOwner,
                                        boolean hasOwner)