org.apache.ftpserver.ftplet
Enum Structure

java.lang.Object
  extended by java.lang.Enum<Structure>
      extended by org.apache.ftpserver.ftplet.Structure
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<Structure>

public enum Structure
extends java.lang.Enum<Structure>

Type safe enum for describing the structure

Version:
$Rev$, $Date$
Author:
The Apache MINA Project (dev@mina.apache.org)

Enum Constant Summary
FILE
          File structure
 
Method Summary
static Structure parseArgument(char argument)
          Parses the argument value from the STRU command into the type safe class
static Structure valueOf(java.lang.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 Detail

FILE

public static final Structure FILE
File structure

Method Detail

values

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

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

valueOf

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

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:
java.lang.IllegalArgumentException - If the structure is unknown


Copyright © 2003-2011 Apache Software Foundation. All Rights Reserved.