org.springframework.integration.file.remote.gateway

Enum AbstractRemoteFileOutboundGateway.Command

java.lang.Object

java.lang.Enum<AbstractRemoteFileOutboundGateway.Command>

org.springframework.integration.file.remote.gateway.AbstractRemoteFileOutboundGateway.Command

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AbstractRemoteFileOutboundGateway.Command>

Enclosing class:

AbstractRemoteFileOutboundGateway<F>

public static enum AbstractRemoteFileOutboundGateway.Command
extends java.lang.Enum<AbstractRemoteFileOutboundGateway.Command>

Enumeration of commands supported by the gateways.

Enum Constant Summary

Enum Constants

Enum Constant and Description
GET Retrieve a remote file.
LS List remote files.
MGET Retrieve multiple files matching a wildcard path.
MPUT Put multiple local files to the remote system.
MV Move (rename) a remote file.
PUT Put a local file to the remote system.
RM Remove a remote file (path - including wildcards).

Method Summary

Methods

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

LS

public static final AbstractRemoteFileOutboundGateway.Command LS

List remote files.

GET

public static final AbstractRemoteFileOutboundGateway.Command GET

Retrieve a remote file.

RM

public static final AbstractRemoteFileOutboundGateway.Command RM

Remove a remote file (path - including wildcards).

MGET

public static final AbstractRemoteFileOutboundGateway.Command MGET

Retrieve multiple files matching a wildcard path.

MV

public static final AbstractRemoteFileOutboundGateway.Command MV

Move (rename) a remote file.

PUT

public static final AbstractRemoteFileOutboundGateway.Command PUT

Put a local file to the remote system.

MPUT

public static final AbstractRemoteFileOutboundGateway.Command MPUT

Put multiple local files to the remote system.

Method Detail

values

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

Returns:

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

valueOf

public static AbstractRemoteFileOutboundGateway.Command 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

getCommand

public java.lang.String getCommand()

toCommand

public static AbstractRemoteFileOutboundGateway.Command toCommand(java.lang.String cmd)