Package org.apache.ignite.internal.processors.configuration.distributed

Class DistributedEnumProperty<T extends Enum>

java.lang.Object

org.apache.ignite.internal.processors.configuration.distributed.DistributedEnumProperty<T>

Type Parameters:

T - Type of enum.

All Implemented Interfaces:

DistributedChangeableProperty<T>, DistributedProperty<T>

public class DistributedEnumProperty<T extends Enum>
extends Object
implements DistributedChangeableProperty<T>

Distributed enum implementation for storing into meta storage. The implementation will serialize by its integer ordinal.

Constructor Summary

Constructors

Constructor	Description
DistributedEnumProperty(String name, String desc, IgniteClosure<Integer,T> fromOrdinalFunc, IgniteClosure<T,Integer> toOrdinalFunc, Class<T> enumCls)	Property constructor.

Method Summary

Modifier and Type	Method	Description
void	addListener(DistributePropertyListener<? super T> listener)
String	description()
T	get()
String	getName()
T	getOrDefault(T dfltVal)
void	localUpdate(Serializable newVal)	Update only local value without updating remote cluster.
void	onAttached()	This property have been attached to processor.
void	onReadyForUpdate(@NotNull PropertyUpdateClosure updater)	On this property ready to be update on cluster wide.
T	parse(String str)
boolean	propagate(T newVal)	Change value across whole cluster.
GridFutureAdapter<?>	propagateAsync(T newVal)	Change value across whole cluster.
GridFutureAdapter<?>	propagateAsync(T expectedVal, T newVal)	Change value across whole cluster.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DistributedEnumProperty

public DistributedEnumProperty(String name,
                               String desc,
                               IgniteClosure<Integer,T> fromOrdinalFunc,
                               IgniteClosure<T,Integer> toOrdinalFunc,
                               Class<T> enumCls)

Property constructor.

Parameters:

name - Name of property.

desc - Property description.

fromOrdinalFunc - Function reflects an integer to an enumiration value.

toOrdinalFunc - Function converts an enumeration value to an integer.

Method Detail

onAttached

public void onAttached()

This property have been attached to processor.

Specified by:

onAttached in interface DistributedChangeableProperty<T extends Enum>

onReadyForUpdate

public void onReadyForUpdate(@NotNull
                             @NotNull PropertyUpdateClosure updater)

On this property ready to be update on cluster wide.

Specified by:

onReadyForUpdate in interface DistributedChangeableProperty<T extends Enum>

Parameters:

updater - Consumer for update value across cluster.

localUpdate

public void localUpdate(Serializable newVal)

Update only local value without updating remote cluster.

Specified by:

localUpdate in interface DistributedChangeableProperty<T extends Enum>

Parameters:

newVal - New value.

propagate

public boolean propagate(T newVal)
                  throws IgniteCheckedException

Change value across whole cluster.

Specified by:

propagate in interface DistributedProperty<T extends Enum>

Parameters:

newVal - Value which this property should be changed on.

Returns:

true if value was successfully updated and false if cluster wide update was failed, perhaps some concurrent operation was changed this value in same moment.

Throws:

DetachedPropertyException - If this property have not been attached to processor yet, please call DistributedConfigurationProcessor.registerProperty(DistributedChangeableProperty) before this method.

NotWritablePropertyException - If this property don't ready to cluster wide update yet, perhaps cluster is not active yet.

IgniteCheckedException - If failed during cluster wide update.

propagateAsync

public GridFutureAdapter<?> propagateAsync(T newVal)
                                    throws IgniteCheckedException

Change value across whole cluster.

Specified by:

propagateAsync in interface DistributedProperty<T extends Enum>

Parameters:

newVal - Value which this property should be changed on.

Returns:

Future for update operation.

Throws:

DetachedPropertyException - If this property have not been attached to processor yet, please call DistributedConfigurationProcessor.registerProperty(DistributedChangeableProperty) before this method.

NotWritablePropertyException - If this property don't ready to cluster wide update yet, perhaps cluster is not active yet.

IgniteCheckedException - If failed during cluster wide update.

propagateAsync

public GridFutureAdapter<?> propagateAsync(T expectedVal,
                                           T newVal)
                                    throws IgniteCheckedException

Change value across whole cluster.

Specified by:

propagateAsync in interface DistributedProperty<T extends Enum>

Parameters:

expectedVal - Value from which this property should be changed.

newVal - Value which this property should be changed on.

Returns:

Future for update operation.

Throws:

DetachedPropertyException - If this property have not been attached to processor yet, please call DistributedConfigurationProcessor.registerProperty(DistributedChangeableProperty) before this method.

NotWritablePropertyException - If this property don't ready to cluster wide update yet, perhaps cluster is not active yet.

IgniteCheckedException - If failed during cluster wide update.

get

public T get()

Specified by:

get in interface DistributedProperty<T extends Enum>

Returns:

Current property value.

getOrDefault

public T getOrDefault(T dfltVal)

Specified by:

getOrDefault in interface DistributedProperty<T extends Enum>

Parameters:

dfltVal - Default value when current value is null.

Returns:

Current property value.

getName

public String getName()

Specified by:

getName in interface DistributedProperty<T extends Enum>

Returns:

Name of property.

description

public String description()

Specified by:

description in interface DistributedProperty<T extends Enum>

Returns:

Property description.

addListener

public void addListener(DistributePropertyListener<? super T> listener)

Specified by:

addListener in interface DistributedProperty<T extends Enum>

Parameters:

listener - Update listener.

parse

public T parse(String str)

Specified by:

parse in interface DistributedChangeableProperty<T extends Enum>

Parameters:

str - String representation of the property value.

Returns:

Property value.

toString

public String toString()

Overrides:

toString in class Object