io.atomix.resource

Class AbstractResource<T extends Resource<T>>

java.lang.Object

io.atomix.resource.AbstractResource<T>

All Implemented Interfaces:

Managed<T>, Resource<T>

public abstract class AbstractResource<T extends Resource<T>>
extends Object
implements Resource<T>

Abstract resource.

Author:

Nested Class Summary

Nested classes/interfaces inherited from interface io.atomix.resource.Resource

Resource.Config, Resource.Options, Resource.State

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Void>	close() Closes the resource.
Resource.Config	config() Returns the resource configuration.
ThreadContext	context() Returns the resource thread context.
CompletableFuture<Void>	delete() Deletes the resource state.
boolean	equals(Object object)
int	hashCode()
boolean	isClosed()
boolean	isOpen()
Listener<Resource.State>	onStateChange(Consumer<Resource.State> callback) Registers a resource state change listener.
CompletableFuture<T>	open() Opens the resource.
Resource.Options	options() Returns the resource options.
Serializer	serializer() Returns the resource serializer.
Resource.State	state() Returns the current resource state.
String	toString()
ResourceType	type() Returns the resource type.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

type

public ResourceType type()

Description copied from interface: Resource

Returns the resource type.

Specified by:

type in interface Resource<T extends Resource<T>>

Returns:

The resource type.

serializer

public Serializer serializer()

Description copied from interface: Resource

Returns the resource serializer.

Specified by:

serializer in interface Resource<T extends Resource<T>>

Returns:

The resource serializer.

config

public Resource.Config config()

Description copied from interface: Resource

Returns the resource configuration.

Specified by:

config in interface Resource<T extends Resource<T>>

Returns:

The resource configuration.

options

public Resource.Options options()

Description copied from interface: Resource

Returns the resource options.

Specified by:

options in interface Resource<T extends Resource<T>>

Returns:

The configured resource options.

state

public Resource.State state()

Description copied from interface: Resource

Returns the current resource state.

The resource's Resource.State is indicative of the resource's ability to communicate with the cluster at any given time. Users of the resource should use the state to determine when guarantees may be lost. See the Resource.State documentation for information on the specific states, and see resource implementation documentation for the implications of different states on resource consistency.

Specified by:

state in interface Resource<T extends Resource<T>>

Returns:

The current resource state.

onStateChange

public Listener<Resource.State> onStateChange(Consumer<Resource.State> callback)

Description copied from interface: Resource

Registers a resource state change listener.

Specified by:

onStateChange in interface Resource<T extends Resource<T>>

Parameters:

callback - The callback to call when the resource state changes.

Returns:

The state change listener.

context

public ThreadContext context()

Description copied from interface: Resource

Returns the resource thread context.

Specified by:

context in interface Resource<T extends Resource<T>>

Returns:

The resource thread context.

open

public CompletableFuture<T> open()

Description copied from interface: Resource

Opens the resource.

Once the resource is opened, the resource will be transitioned to the Resource.State.CONNECTED state and the returned CompletableFuture will be completed.

Specified by:

open in interface Managed<T extends Resource<T>>

Specified by:

open in interface Resource<T extends Resource<T>>

Returns:

A completable future to be completed once the resource is opened.

isOpen

public boolean isOpen()

Specified by:

isOpen in interface Managed<T extends Resource<T>>

close

public CompletableFuture<Void> close()

Description copied from interface: Resource

Closes the resource.

Once the resource is closed, the resource will be transitioned to the Resource.State.CLOSED state and the returned CompletableFuture will be completed. Thereafter, attempts to operate on the resource will fail.

Specified by:

close in interface Managed<T extends Resource<T>>

Specified by:

close in interface Resource<T extends Resource<T>>

Returns:

A completable future to be completed once the resource is closed.

isClosed

public boolean isClosed()

Specified by:

isClosed in interface Managed<T extends Resource<T>>

delete

public CompletableFuture<Void> delete()

Description copied from interface: Resource

Deletes the resource state.

Specified by:

delete in interface Resource<T extends Resource<T>>

Returns:

A completable future to be completed once the resource has been deleted.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object object)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object