org.sodeac.common.message.dispatcher.api

Enum PrivateChannelWorkerRequirement

java.lang.Object

java.lang.Enum<PrivateChannelWorkerRequirement>

org.sodeac.common.message.dispatcher.api.PrivateChannelWorkerRequirement

All Implemented Interfaces:

Serializable, Comparable<PrivateChannelWorkerRequirement>

public enum PrivateChannelWorkerRequirement
extends Enum<PrivateChannelWorkerRequirement>

Declares the necessity to use same queue worker thread for synchronized queue activities at all times. Otherwise the used worker can shared with other queues for synchronized queue activities. In both cases the exclusive access to queue resources is guaranteed.

Condition	Result
At least one IChannelComponent claims to use private worker by RequirePrivateChannelWorker	Use private Worker (always)
More IChannelComponents prefer to use same worker (PreferPrivateChannelWorker) then not (PreferSharedChannelWorker)	Use private Worker (if no IChannelComponent claims to use private worker by RequirePrivateChannelWorker)
More IChannelComponents prefer to use shared worker (PreferSharedChannelWorker) then not (PreferPrivateChannelWorker)	Use shared Worker (if no IChannelComponent claims to use private worker by RequirePrivateChannelWorker)
No IChannelComponents has a preference or a requirement / all IChannelComponents declare NoPreferenceOrRequirement	Use shared Worker

Private worker can be useful, if IChannelComponent use thread sensitive libraries like Mozilla Rhino.

Since:

1.0

Version:

1.0

Author:

Sebastian Palarus

Enum Constant Summary

Enum Constants

Enum Constant and Description
NoPreferenceOrRequirement It does not matter if queue use private or shared queue worker
PreferPrivateChannelWorker Preference to use private queue worker.
PreferSharedChannelWorker Preference to use shared queue worker.
RequirePrivateChannelWorker IChannelComponent requires a private queue worker.

Method Summary

Modifier and Type	Method and Description
static PrivateChannelWorkerRequirement	findByInteger(int value) search privateQueueWorker enum represents by value
static PrivateChannelWorkerRequirement	findByName(String name) search privateQueueWorker enum represents by name
static Set<PrivateChannelWorkerRequirement>	getAll() getter for all privateQueueWorker
static PrivateChannelWorkerRequirement	valueOf(String name) Returns the enum constant of this type with the specified name.
static PrivateChannelWorkerRequirement[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PreferSharedChannelWorker

public static final PrivateChannelWorkerRequirement PreferSharedChannelWorker

Preference to use shared queue worker.

NoPreferenceOrRequirement

public static final PrivateChannelWorkerRequirement NoPreferenceOrRequirement

It does not matter if queue use private or shared queue worker

PreferPrivateChannelWorker

public static final PrivateChannelWorkerRequirement PreferPrivateChannelWorker

Preference to use private queue worker.

RequirePrivateChannelWorker

public static final PrivateChannelWorkerRequirement RequirePrivateChannelWorker

IChannelComponent requires a private queue worker.

Method Detail

values

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

Returns:

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

valueOf

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

getAll

public static Set<PrivateChannelWorkerRequirement> getAll()

getter for all privateQueueWorker

Returns:

Set of all privateQueueWorker

findByInteger

public static PrivateChannelWorkerRequirement findByInteger(int value)

search privateQueueWorker enum represents by value

Parameters:

value - integer value of privateQueueWorker

Returns:

privateQueueWorker enum represents by value

findByName

public static PrivateChannelWorkerRequirement findByName(String name)

search privateQueueWorker enum represents by name

Parameters:

name - of privateQueueWorker

Returns:

enum represents by name