Package io.guise.framework.platform.web

Enum WebResourceCollectDepictor.ResourceCollectCommand

java.lang.Object

java.lang.Enum<WebResourceCollectDepictor.ResourceCollectCommand>

io.guise.framework.platform.web.WebResourceCollectDepictor.ResourceCollectCommand

All Implemented Interfaces:

com.globalmentor.lex.Identifier, com.globalmentor.lex.Token, PlatformCommand, WebPlatformCommand, java.io.Serializable, java.lang.Comparable<WebResourceCollectDepictor.ResourceCollectCommand>

Enclosing class:

WebResourceCollectDepictor<C extends ResourceCollectControl>

public static enum WebResourceCollectDepictor.ResourceCollectCommand
extends java.lang.Enum<WebResourceCollectDepictor.ResourceCollectCommand>
implements WebPlatformCommand

The web commands for controlling a resource collect control.

Enum Constant Summary

Enum Constants

Enum Constant	Description
RESOURCE_COLLECT_CANCEL	The command to cancel a resource transfer.
RESOURCE_COLLECT_COMPLETE	The command to complete receiving resources.
RESOURCE_COLLECT_RECEIVE	The command to start receiving resources.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DESTINATION_URI_PROPERTY	The property for specifying the destination URI of the resources to receive.

Method Summary

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

RESOURCE_COLLECT_RECEIVE

public static final WebResourceCollectDepictor.ResourceCollectCommand RESOURCE_COLLECT_RECEIVE

The command to start receiving resources. parameters: {"destinationURI":"destinationURI"}

RESOURCE_COLLECT_COMPLETE

public static final WebResourceCollectDepictor.ResourceCollectCommand RESOURCE_COLLECT_COMPLETE

The command to complete receiving resources.

RESOURCE_COLLECT_CANCEL

public static final WebResourceCollectDepictor.ResourceCollectCommand RESOURCE_COLLECT_CANCEL

The command to cancel a resource transfer.

Field Detail

DESTINATION_URI_PROPERTY

public static final java.lang.String DESTINATION_URI_PROPERTY

The property for specifying the destination URI of the resources to receive.

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

public static WebResourceCollectDepictor.ResourceCollectCommand 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