org.springframework.integration.file.remote.gateway

Enum AbstractRemoteFileOutboundGateway.Option

java.lang.Object

java.lang.Enum<AbstractRemoteFileOutboundGateway.Option>

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

All Implemented Interfaces:

Serializable, Comparable<AbstractRemoteFileOutboundGateway.Option>

Enclosing class:

AbstractRemoteFileOutboundGateway<F>

public static enum AbstractRemoteFileOutboundGateway.Option
extends Enum<AbstractRemoteFileOutboundGateway.Option>

Enumeration of options supported by various commands.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL (-a) Include files beginning with ., including directories . and .. in the results (ls).
DELETE (-D) Delete the remote file after successful transfer (get, mget).
EXCEPTION_WHEN_EMPTY (-x) Throw an exception if no files returned (mget).
LINKS (-links) Include links in the results (ls).
NAME_ONLY (-1) Don't return full file information; just the name (ls).
NOSORT (-f) Do not sort the results (ls with NAME_ONLY).
PRESERVE_TIMESTAMP (-P) Preserve the server timestamp (get, mget).
RECURSIVE (-R) Recursive (ls, mget)
STREAM (-stream) Streaming 'get' (returns InputStream); user must call Session.close().
SUBDIRS (-dirs) Include directories in the results (ls).

Method Summary

Modifier and Type	Method and Description
String	getOption()
static AbstractRemoteFileOutboundGateway.Option	toOption(String opt)
static AbstractRemoteFileOutboundGateway.Option	valueOf(String name) Returns the enum constant of this type with the specified name.
static AbstractRemoteFileOutboundGateway.Option[]	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

NAME_ONLY

public static final AbstractRemoteFileOutboundGateway.Option NAME_ONLY

(-1) Don't return full file information; just the name (ls).

ALL

public static final AbstractRemoteFileOutboundGateway.Option ALL

(-a) Include files beginning with ., including directories . and .. in the results (ls).

NOSORT

public static final AbstractRemoteFileOutboundGateway.Option NOSORT

(-f) Do not sort the results (ls with NAME_ONLY).

SUBDIRS

public static final AbstractRemoteFileOutboundGateway.Option SUBDIRS

(-dirs) Include directories in the results (ls).

LINKS

public static final AbstractRemoteFileOutboundGateway.Option LINKS

(-links) Include links in the results (ls).

PRESERVE_TIMESTAMP

public static final AbstractRemoteFileOutboundGateway.Option PRESERVE_TIMESTAMP

(-P) Preserve the server timestamp (get, mget).

EXCEPTION_WHEN_EMPTY

public static final AbstractRemoteFileOutboundGateway.Option EXCEPTION_WHEN_EMPTY

(-x) Throw an exception if no files returned (mget).

RECURSIVE

public static final AbstractRemoteFileOutboundGateway.Option RECURSIVE

(-R) Recursive (ls, mget)

STREAM

public static final AbstractRemoteFileOutboundGateway.Option STREAM

(-stream) Streaming 'get' (returns InputStream); user must call Session.close().

DELETE

public static final AbstractRemoteFileOutboundGateway.Option DELETE

(-D) Delete the remote file after successful transfer (get, mget).

Method Detail

values

public static AbstractRemoteFileOutboundGateway.Option[] 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.Option c : AbstractRemoteFileOutboundGateway.Option.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.Option 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

getOption

public String getOption()

toOption

public static AbstractRemoteFileOutboundGateway.Option toOption(String opt)