com.github.robtimus.filesystems.ftp

Enum FileStructure

java.lang.Object

java.lang.Enum<FileStructure>

com.github.robtimus.filesystems.ftp.FileStructure

All Implemented Interfaces:

Serializable, Comparable<FileStructure>, CopyOption, OpenOption

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

The possible FTP file structures.

Author:

Rob Spoor

Enum Constant Summary

Enum Constants

Enum Constant and Description
FILE Indicates that files are to be treated as a continuous sequence of bytes.
PAGE Indicates that files are to be treated as a set of independent indexed pages.
RECORD Indicates that files are to be treated as a sequence of records.

Method Summary

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

FILE

public static final FileStructure FILE

Indicates that files are to be treated as a continuous sequence of bytes.

RECORD

public static final FileStructure RECORD

Indicates that files are to be treated as a sequence of records.

PAGE

public static final FileStructure PAGE

Indicates that files are to be treated as a set of independent indexed pages.

Method Detail

values

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

Returns:

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

valueOf

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