Package net.sf.basedb.opengrid.config

Enum ClusterType

java.lang.Object

java.lang.Enum<ClusterType>

net.sf.basedb.opengrid.config.ClusterType

All Implemented Interfaces:

Serializable, Comparable<ClusterType>, java.lang.constant.Constable

public enum ClusterType
extends Enum<ClusterType>

Enumeration with cluster types that are supported by this plugin.

Since:

1.4

Author:

nicklas

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DIRECT	The "cluster" doesn't have an manager, but jobs are started immediately when submitted.
OPENGRID	The cluster is an Open Grid Engine cluster.
SLURM	The cluster is a Slurm Workload Manager cluster.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ClusterType()

Method Summary

Modifier and Type	Method	Description
abstract ClusterEngine	createEngine()	Create a new engine instance to use for cluster-specific operations.
static ClusterType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ClusterType[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

OPENGRID

public static final ClusterType OPENGRID

The cluster is an Open Grid Engine cluster.

SLURM

public static final ClusterType SLURM

The cluster is a Slurm Workload Manager cluster.

DIRECT

public static final ClusterType DIRECT

The "cluster" doesn't have an manager, but jobs are started immediately when submitted. Intended to be uses for development and testing only.

Since:

1.5

Constructor Details

ClusterType

private ClusterType()

Method Details

values

public static ClusterType[] values()

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

Returns:

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

valueOf

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

createEngine

public abstract ClusterEngine createEngine()

Create a new engine instance to use for cluster-specific operations. If the engine is thread-safe, a singleton instance can be used, otherwise a new engine should be created each time this method is called.