Package org.refcodes.data

Enum PollLoopTime

java.lang.Object

java.lang.Enum<PollLoopTime>

org.refcodes.data.PollLoopTime

All Implemented Interfaces:

Serializable, Comparable<PollLoopTime>, org.refcodes.mixin.MillisecondsAccessor

public enum PollLoopTime
extends Enum<PollLoopTime>
implements org.refcodes.mixin.MillisecondsAccessor

The PollLoopTime defined values used when polling data from I/O, e.g. the file system or via TCP/IP.

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.mixin.MillisecondsAccessor

org.refcodes.mixin.MillisecondsAccessor.MillisecondsBuilder<B extends org.refcodes.mixin.MillisecondsAccessor.MillisecondsBuilder<B>>, org.refcodes.mixin.MillisecondsAccessor.MillisecondsMutator, org.refcodes.mixin.MillisecondsAccessor.MillisecondsProperty

Enum Constant Summary

Enum Constants

Enum Constant	Description
MAX
MIN
NORM

Method Summary

Modifier and Type	Method	Description
int	getMilliseconds()
static PollLoopTime	valueOf(String name)	Returns the enum constant of this type with the specified name.
static PollLoopTime[]	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

MIN

public static final PollLoopTime MIN

NORM

public static final PollLoopTime NORM

MAX

public static final PollLoopTime MAX

Method Detail

values

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

Returns:

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

valueOf

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

getMilliseconds

public int getMilliseconds()

Specified by:

getMilliseconds in interface org.refcodes.mixin.MillisecondsAccessor