com.github.robtimus.filesystems.ftp

Enum FileTransferMode

java.lang.Object

java.lang.Enum<FileTransferMode>

com.github.robtimus.filesystems.ftp.FileTransferMode

All Implemented Interfaces:

Serializable, Comparable<FileTransferMode>, CopyOption, OpenOption

public enum FileTransferMode
extends Enum<FileTransferMode>
implements OpenOption, CopyOption

The possible FTP file transfer modes.

Author:

Rob Spoor

Enum Constant Summary

Enum Constants

Enum Constant and Description
BLOCK Indicates that files are to be transfered as series of blocks.
COMPRESSED Indicate that files are to be transfered as FTP compressed data.
DEFLATE Indicate that files are to be transferred as FTP (un)compressing data in the "deflate" compression format.
STREAM Indicates that files are to be transfered as streams of bytes.

Method Summary

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

STREAM

public static final FileTransferMode STREAM

Indicates that files are to be transfered as streams of bytes.

BLOCK

public static final FileTransferMode BLOCK

Indicates that files are to be transfered as series of blocks.

COMPRESSED

public static final FileTransferMode COMPRESSED

Indicate that files are to be transfered as FTP compressed data.

DEFLATE

public static final FileTransferMode DEFLATE

Indicate that files are to be transferred as FTP (un)compressing data in the "deflate" compression format.

Since:

3.3

Method Detail

values

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

Returns:

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

valueOf

public static FileTransferMode 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