org.opendaylight.mdsal.eos.common.api

Class GenericEntityOwnershipChange<P extends org.opendaylight.yangtools.concepts.Path<P>,E extends GenericEntity<P>>

java.lang.Object

org.opendaylight.mdsal.eos.common.api.GenericEntityOwnershipChange<P,E>

Type Parameters:

P - the instance identifier path type

E - the GenericEntity type

Direct Known Subclasses:

DOMEntityOwnershipChange, EntityOwnershipChange

public class GenericEntityOwnershipChange<P extends org.opendaylight.yangtools.concepts.Path<P>,E extends GenericEntity<P>>
extends Object

A DTO that encapsulates an ownership change for an entity.

Author:

Thomas Pantelis

Constructor Summary

Constructors

Constructor and Description
GenericEntityOwnershipChange(E entity, @NonNull EntityOwnershipChangeState state)
GenericEntityOwnershipChange(E entity, @NonNull EntityOwnershipChangeState state, boolean inJeopardy)

Method Summary

Modifier and Type	Method and Description
E	getEntity() Returns the entity whose ownership status changed.
@NonNull EntityOwnershipChangeState	getState() Returns the ownership change state.
boolean	inJeopardy() Returns the current jeopardy state.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GenericEntityOwnershipChange

public GenericEntityOwnershipChange(E entity,
                                    @NonNull EntityOwnershipChangeState state)

GenericEntityOwnershipChange

public GenericEntityOwnershipChange(E entity,
                                    @NonNull EntityOwnershipChangeState state,
                                    boolean inJeopardy)

Method Detail

getEntity

public E getEntity()

Returns the entity whose ownership status changed.

Returns:

the entity

getState

public @NonNull EntityOwnershipChangeState getState()

Returns the ownership change state.

Returns:

an EntityOwnershipChangeState enum

inJeopardy

public boolean inJeopardy()

Returns the current jeopardy state. When in a jeopardy state, the values from other methods may potentially be out of date.

Returns:

true if the local node is in a jeopardy state. If false, the reported information is accurate.

toString

public String toString()

Overrides:

toString in class Object