org.apache.ftpserver.ftplet
Class FtpletEnum

java.lang.Object
  org.apache.ftpserver.ftplet.FtpletEnum

public final class FtpletEnum
extends java.lang.Object

This class encapsulates the return values of the ftplet methods. RET_DEFAULT < RET_NO_FTPLET < RET_SKIP < RET_DISCONNECT

Field Summary

static FtpletEnum	RET_DEFAULT This return value indicates that the next ftplet method will be called.
static FtpletEnum	RET_DISCONNECT It indicates that the server will skip and disconnect the client.
static FtpletEnum	RET_NO_FTPLET This return value indicates that the other ftplet methods will not be called but the ftpserver will continue processing this request.
static FtpletEnum	RET_SKIP It indicates that the ftpserver will skip everything.

Method Summary

boolean	equals(java.lang.Object obj) Equality check
java.lang.String	toString() String representation

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

RET_DEFAULT

public static final FtpletEnum RET_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.

RET_NO_FTPLET

public static final FtpletEnum RET_NO_FTPLET

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

RET_SKIP

public static final FtpletEnum RET_SKIP

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

RET_DISCONNECT

public static final FtpletEnum RET_DISCONNECT

It indicates that the server will skip and disconnect the client. No other request from the same client will be served.

Method Detail

equals

public boolean equals(java.lang.Object obj)

Equality check

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

String representation

Overrides:

toString in class java.lang.Object