net.obvj.agents

Enum AgentType

java.lang.Object

java.lang.Enum<AgentType>

net.obvj.agents.AgentType

All Implemented Interfaces:

Serializable, Comparable<AgentType>

public enum AgentType
extends Enum<AgentType>

Enumerates available Agent types and associated facilities.

Author:

oswaldo.bapvic.jr

Enum Constant Summary

Enum Constants

Enum Constant and Description
CRON An object that runs a particular task at specified times and dates, similar to the Cron service available in Unix/Linux systems.
TIMER An object that runs a particular task periodically, given a configurable interval in seconds, minutes, or hours.

Method Summary

Modifier and Type	Method and Description
String	getDefaultInterval() Returns the default interval for an agent type.
Function<AgentConfiguration,AbstractAgent>	getFactoryFunction() Returns the default factory Function to be applied for instantiating new agents of this type.
static AgentType	valueOf(String name) Returns the enum constant of this type with the specified name.
static AgentType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TIMER

public static final AgentType TIMER

An object that runs a particular task periodically, given a configurable interval in seconds, minutes, or hours.

CRON

public static final AgentType CRON

An object that runs a particular task at specified times and dates, similar to the Cron service available in Unix/Linux systems.

Method Detail

values

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

Returns:

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

valueOf

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

getDefaultInterval

public String getDefaultInterval()

Returns the default interval for an agent type.

Returns:

the default interval

getFactoryFunction

public Function<AgentConfiguration,AbstractAgent> getFactoryFunction()

Returns the default factory Function to be applied for instantiating new agents of this type.

Returns:

the factory Function