Enum Class 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>
,Constable
- Enclosing class:
- AbstractRemoteFileOutboundGateway<F>
public static enum AbstractRemoteFileOutboundGateway.Option
extends Enum<AbstractRemoteFileOutboundGateway.Option>
Enumeration of options supported by various commands.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescription(-a) Include files beginning with.
, including directories.
and..
in the results (ls).(-D) Delete the remote file after successful transfer (get, mget).(-x) Throw an exception if no files returned (mget).(-links) Include links in the results (ls).(-1) Don't return full file information; just the name (ls).(-f) Do not sort the results (ls with NAME_ONLY).(-P) Preserve the server timestamp (get, mget).(-R) Recursive (ls, mget).(-stream) Streaming 'get' (returns InputStream); user must callSession.close()
.(-dirs) Include directories in the results (ls). -
Method Summary
Modifier and TypeMethodDescriptionReturns the enum constant of this class with the specified name.values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
NAME_ONLY
(-1) Don't return full file information; just the name (ls). -
ALL
(-a) Include files beginning with.
, including directories.
and..
in the results (ls). -
NOSORT
(-f) Do not sort the results (ls with NAME_ONLY). -
SUBDIRS
(-dirs) Include directories in the results (ls). -
LINKS
(-links) Include links in the results (ls). -
PRESERVE_TIMESTAMP
(-P) Preserve the server timestamp (get, mget). -
EXCEPTION_WHEN_EMPTY
(-x) Throw an exception if no files returned (mget). -
RECURSIVE
(-R) Recursive (ls, mget). -
STREAM
(-stream) Streaming 'get' (returns InputStream); user must callSession.close()
. -
DELETE
(-D) Delete the remote file after successful transfer (get, mget).
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified nameNullPointerException
- if the argument is null
-
getOption
-
toOption
-