com.guiseframework.platform.web
Enum WebPlatform.PollCommand

java.lang.Object
  java.lang.Enum<WebPlatform.PollCommand>
      com.guiseframework.platform.web.WebPlatform.PollCommand

All Implemented Interfaces:

PlatformCommand, WebPlatformCommand, java.io.Serializable, java.lang.Comparable<WebPlatform.PollCommand>

Enclosing interface:

WebPlatform

public static enum WebPlatform.PollCommand
extends java.lang.Enum<WebPlatform.PollCommand>
implements WebPlatformCommand

The web commands for controlling polling.

Enum Constant Summary

POLL_INTERVAL
The command to set the polling interval.

Field Summary

static java.lang.String

INTERVAL_PROPERTY The property for specifying the poll interval in milliseconds.

Method Summary

static WebPlatform.PollCommand	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static WebPlatform.PollCommand[]	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

POLL_INTERVAL

public static final WebPlatform.PollCommand POLL_INTERVAL

The command to set the polling interval. parameters: {:"interval"}

Field Detail

INTERVAL_PROPERTY

public static final java.lang.String INTERVAL_PROPERTY

The property for specifying the poll interval in milliseconds.

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

public static WebPlatform.PollCommand valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null