org.jtrim2.concurrent.query

Enum DoNothingDataController

java.lang.Object

java.lang.Enum<DoNothingDataController>

org.jtrim2.concurrent.query.DoNothingDataController

All Implemented Interfaces:

Serializable, Comparable<DoNothingDataController>, AsyncDataController

public enum DoNothingDataController
extends Enum<DoNothingDataController>
implements AsyncDataController

Defines an AsyncDataController which does nothing and always returns null as the state of progress.

This class is a singleton and its one and only instance is: INSTANCE.

Thread safety

The instance of this class are immutable and as such is safe to be accessed by multiple threads concurrently.

Synchronization transparency

The methods of this class are synchronization transparent.

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE The one and only instance of DoNothingDataController.

Method Summary

Modifier and Type	Method and Description
void	controlData(Object controlArg) Does nothing and returns immediately to the caller.
AsyncDataState	getDataState() Does nothing and returns null.
String	toString() Returns the string representation of this DoNothingDataController in no particular format.
static DoNothingDataController	valueOf(String name) Returns the enum constant of this type with the specified name.
static DoNothingDataController[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final DoNothingDataController INSTANCE

The one and only instance of DoNothingDataController.

Method Detail

values

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

Returns:

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

valueOf

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

controlData

public void controlData(Object controlArg)

Does nothing and returns immediately to the caller.

Specified by:

controlData in interface AsyncDataController

Parameters:

controlArg - this argument is ignored.

getDataState

public AsyncDataState getDataState()

Does nothing and returns null.

Specified by:

getDataState in interface AsyncDataController

Returns:

null always

toString

public String toString()

Returns the string representation of this DoNothingDataController in no particular format.

This method is intended to be used for debugging only.

Overrides:

toString in class Enum<DoNothingDataController>

Returns:

the string representation of this object in no particular format. This method never returns null.