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:

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

Enclosing class:

AbstractRemoteFileOutboundGateway<F>

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

Enumeration of options supported by various commands.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL Include files beginning with ., including directories . and .. in the results (ls).
EXCEPTION_WHEN_EMPTY Throw an exception if no files returned (mget).
LINKS Include links in the results (ls).
NAME_ONLY Don't return full file information; just the name (ls).
NOSORT Do not sort the results (ls with NAME_ONLY).
PRESERVE_TIMESTAMP Preserve the server timestamp (get, mget).
RECURSIVE Recursive (ls, mget)
SUBDIRS Include directories in the results (ls).

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getOption()
static AbstractRemoteFileOutboundGateway.Option	toOption(java.lang.String opt)
static AbstractRemoteFileOutboundGateway.Option	valueOf(java.lang.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

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

ALL

public static final AbstractRemoteFileOutboundGateway.Option ALL

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

NOSORT

public static final AbstractRemoteFileOutboundGateway.Option NOSORT

Do not sort the results (ls with NAME_ONLY).

SUBDIRS

public static final AbstractRemoteFileOutboundGateway.Option SUBDIRS

Include directories in the results (ls).

LINKS

public static final AbstractRemoteFileOutboundGateway.Option LINKS

Include links in the results (ls).

PRESERVE_TIMESTAMP

public static final AbstractRemoteFileOutboundGateway.Option PRESERVE_TIMESTAMP

Preserve the server timestamp (get, mget).

EXCEPTION_WHEN_EMPTY

public static final AbstractRemoteFileOutboundGateway.Option EXCEPTION_WHEN_EMPTY

Throw an exception if no files returned (mget).

RECURSIVE

public static final AbstractRemoteFileOutboundGateway.Option RECURSIVE

Recursive (ls, 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(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

getOption

public java.lang.String getOption()

toOption

public static AbstractRemoteFileOutboundGateway.Option toOption(java.lang.String opt)