Package org.apache.ftpserver.ftplet

Enum FtpletResult

java.lang.Object

java.lang.Enum<FtpletResult>

org.apache.ftpserver.ftplet.FtpletResult

All Implemented Interfaces:

Serializable, Comparable<FtpletResult>

public enum FtpletResult
extends Enum<FtpletResult>

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

Author:

Apache MINA Project

Enum Constant Summary

Enum Constants

Enum Constant	Description
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

Modifier and Type	Method	Description
static FtpletResult	valueOf(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 Details

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 Details

values

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