org.apache.ftpserver.ftplet
Enum FtpletResult

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

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

This class encapsulates the return values of the ftplet methods. DEFAULT < NO_FTPLET < SKIP < DISCONNECT

Version:
$Rev: 686639 $, $Date: 2008-08-17 22:13:28 +0200 (Sun, 17 Aug 2008) $
Author:
The Apache MINA Project (dev@mina.apache.org)

Enum Constant Summary
DEFAULT
          This return value indicates that the next ftplet method will be called.
DISCONNECT
          It indicates that the server will skip and disconnect the client.
NO_FTPLET
          This return value indicates that the other ftplet methods will not be called but the ftpserver will continue processing this request.
SKIP
          It indicates that the ftpserver will skip everything.
 
Method Summary
static FtpletResult valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static FtpletResult[] 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

DEFAULT

public static final FtpletResult DEFAULT
This return value indicates that the next ftplet method will be called. If no other ftplet is available, the ftpserver will process the request.


NO_FTPLET

public static final FtpletResult NO_FTPLET
This return value indicates that the other ftplet methods will not be called but the ftpserver will continue processing this request.


SKIP

public static final FtpletResult SKIP
It indicates that the ftpserver will skip everything. No further processing (both ftplet and server) will be done for this request.


DISCONNECT

public static final FtpletResult DISCONNECT
It indicates that the server will skip and disconnect the client. No other request from the same client will be served.

Method Detail

values

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

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

valueOf

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


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