tribble.net.ftp
Class FTPException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by java.io.IOException
              extended by tribble.net.ftp.FTPException
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
FTPStoppedException

public class FTPException
extends java.io.IOException

Simple FTP exception. Represents the I/O exceptions thrown by FTP clients and servers.

Since:
API 1.0, 2006-05-09
Version:
API 2.0 $Revision: 1.3 $ $Date: 2010/07/12 21:30:20 $
Author:
David R. Tribble (david@tribble.com).

Copyright 2006-2010 by David R. Tribble, all rights reserved.
Permission is granted to any person or entity except those designated by the United States Department of State as a terrorist, or terrorist government or agency, to use and distribute this source code provided that the original copyright notice remains present and unaltered.

See Also:
FTPClientI, FTPClientAdapter, FTPClient, Serialized Form

Constructor Summary
FTPException()
          Default constructor.
FTPException(int code, java.lang.String msg)
          Constructor.
FTPException(int code, java.lang.String msg, java.lang.Throwable cause)
          Constructor.
FTPException(java.lang.String msg)
          Constructor.
FTPException(java.lang.String msg, java.lang.Throwable cause)
          Constructor.
 
Method Summary
 int getErrorCode()
          Retrieve the FTP error code associated with this exception.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

FTPException

public FTPException()
Default constructor.

Since:
1.1, 2006-05-09

FTPException

public FTPException(java.lang.String msg)
Constructor.

Parameters:
msg - Message detailing this exception.
Since:
1.1, 2006-05-09

FTPException

public FTPException(int code,
                    java.lang.String msg)
Constructor.

Parameters:
code - FTP error code.
msg - Message detailing this exception.
Since:
1.2, 2006-06-03

FTPException

public FTPException(java.lang.String msg,
                    java.lang.Throwable cause)
Constructor.

Parameters:
msg - Message detailing this exception.
cause - Exception that caused this exception.
Since:
1.1, 2006-05-09

FTPException

public FTPException(int code,
                    java.lang.String msg,
                    java.lang.Throwable cause)
Constructor.

Parameters:
code - FTP error code.
msg - Message detailing this exception.
cause - Exception that caused this exception.
Since:
1.2, 2006-06-03
Method Detail

getErrorCode

public int getErrorCode()
Retrieve the FTP error code associated with this exception.

Returns:
FTP error code, or zero if this exception has none.
Since:
1.2, 2006-06-03