gov.usgs.earthquake.nshmp.calc

Enum ThreadCount

java.lang.Object

java.lang.Enum<ThreadCount>

gov.usgs.earthquake.nshmp.calc.ThreadCount

All Implemented Interfaces:

Serializable, Comparable<ThreadCount>

public enum ThreadCount
extends Enum<ThreadCount>

The number of threads with which to intialize thread pools. Values reference the number of non-competing threads that could be supported on a particular system as determined by calling Runtime.availableProcessors().

Author:

Peter Powers

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL All possible non-competing threads.
HALF The greater of one and half of ALL.
N_MINUS_2 The greater of one and two less than ALL.
ONE A single thread.
QUARTER The greater of one and a quarter of ALL.

Method Summary

Modifier and Type	Method and Description
abstract int	value() The number of threads relative to the number of available processors on a system.
static ThreadCount	valueOf(String name) Returns the enum constant of this type with the specified name.
static ThreadCount[]	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

ONE

public static final ThreadCount ONE

A single thread. This identifier will typically cause a program to either use Guava's MoreExecutors.directExecutor() or skip using an ExecutorService altogether, and all calculations will be run on the thread from which a program was called. This is useful for debugging.

QUARTER

public static final ThreadCount QUARTER

The greater of one and a quarter of ALL.

HALF

public static final ThreadCount HALF

The greater of one and half of ALL.

N_MINUS_2

public static final ThreadCount N_MINUS_2

The greater of one and two less than ALL.

ALL

public static final ThreadCount ALL

All possible non-competing threads. The number of threads will equal the number of available processors.

Method Detail

values

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

Returns:

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

valueOf

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

value

public abstract int value()

The number of threads relative to the number of available processors on a system. The value returned will never be less than one.