org.onosproject.store.service

Class Synchronous<T extends DistributedPrimitive>

java.lang.Object

org.onosproject.store.service.Synchronous<T>

Type Parameters:

T - type of DistributedPrimitive

All Implemented Interfaces:

DistributedPrimitive

Direct Known Subclasses:

DefaultAtomicCounter, DefaultAtomicCounterMap, DefaultAtomicIdGenerator, DefaultAtomicValue, DefaultConsistentMap, DefaultConsistentMultimap, DefaultConsistentTreeMap, DefaultDistributedLock, DefaultDistributedSet, DefaultDocumentTree, DefaultLeaderElector

public abstract class Synchronous<T extends DistributedPrimitive>
extends Object
implements DistributedPrimitive

DistributedPrimitive that is a synchronous (blocking) version of another.

Nested Class Summary

Nested classes/interfaces inherited from interface org.onosproject.store.service.DistributedPrimitive

DistributedPrimitive.Status, DistributedPrimitive.Type

Field Summary

Fields inherited from interface org.onosproject.store.service.DistributedPrimitive

DEFAULT_OPERATION_TIMEOUT_MILLIS, DEFAULT_OPERTATION_TIMEOUT_MILLIS

Constructor Summary

Constructors

Constructor and Description
Synchronous(T primitive)

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Void>	destroy() Purges state associated with this primitive.
String	name() Returns the name of this primitive.
DistributedPrimitive.Type	primitiveType() Returns the type of primitive.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.onosproject.store.service.DistributedPrimitive

addStatusChangeListener, applicationId, removeStatusChangeListener, statusChangeListeners

Constructor Detail

Synchronous

public Synchronous(T primitive)

Method Detail

name

public String name()

Description copied from interface: DistributedPrimitive

Returns the name of this primitive.

Specified by:

name in interface DistributedPrimitive

Returns:

name

primitiveType

public DistributedPrimitive.Type primitiveType()

Description copied from interface: DistributedPrimitive

Returns the type of primitive.

Specified by:

primitiveType in interface DistributedPrimitive

Returns:

primitive type

destroy

public CompletableFuture<Void> destroy()

Description copied from interface: DistributedPrimitive

Purges state associated with this primitive.

Implementations can override and provide appropriate clean up logic for purging any state state associated with the primitive. Whether modifications made within the destroy method have local or global visibility is left unspecified.

Specified by:

destroy in interface DistributedPrimitive

Returns:

CompletableFuture that is completed when the operation completes