com.hcl.domino.design.agent

Enum AgentInterval

java.lang.Object

java.lang.Enum<AgentInterval>

com.hcl.domino.design.agent.AgentInterval

All Implemented Interfaces:

INumberEnum<Short>, Serializable, Comparable<AgentInterval>

public enum AgentInterval
extends Enum<AgentInterval>
implements INumberEnum<Short>

Since:

1.0.24

Author:

Jesse Gallagher

Enum Constant Summary

Enum Constants

Enum Constant and Description
DAYS
EVENT
MINUTES
MONTH
NONE Unknown
WEEK

Method Summary

Modifier and Type	Method and Description
long	getLongValue()
Short	getValue()
static AgentInterval	valueOf(String name) Returns the enum constant of this type with the specified name.
static AgentInterval[]	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

NONE

public static final AgentInterval NONE

Unknown

MINUTES

public static final AgentInterval MINUTES

DAYS

public static final AgentInterval DAYS

WEEK

public static final AgentInterval WEEK

MONTH

public static final AgentInterval MONTH

EVENT

public static final AgentInterval EVENT

Method Detail

values

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

Returns:

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

valueOf

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

getValue

public Short getValue()

Specified by:

getValue in interface INumberEnum<Short>

Returns:

the C-level value of the enum

getLongValue

public long getLongValue()

Specified by:

getLongValue in interface INumberEnum<Short>

Returns:

the C-level value of the enum as a long