Package org.apache.ftpserver.ftplet

Enum Structure

java.lang.Object

java.lang.Enum<Structure>

org.apache.ftpserver.ftplet.Structure

All Implemented Interfaces:

Serializable, Comparable<Structure>

public enum Structure
extends Enum<Structure>

Type safe enum for describing the structure

Author:

Apache MINA Project

Enum Constant Summary

Enum Constants

Enum Constant	Description
FILE	File structure

Method Summary

Modifier and Type	Method	Description
static Structure	parseArgument(char argument)	Parses the argument value from the STRU command into the type safe class
static Structure	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Structure[]	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 Details

FILE

public static final Structure FILE

File structure

Method Details

values

public static Structure[] values()

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

Returns:

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

valueOf

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

parseArgument

public static Structure parseArgument(char argument)

Parses the argument value from the STRU command into the type safe class

Parameters:

argument - The argument value from the STRU command. Not case sensitive

Returns:

The appropriate structure

Throws:

IllegalArgumentException - If the structure is unknown