org.xbib.io.ftp.fs.FTPFileSystemException Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ftp-fs Show documentation

Java FTP client, Java FTP NIO file system, Groovy FTP client

There is a newer version: 2.6.0

package org.xbib.io.ftp.fs;

import java.nio.file.FileSystemException;

/**
 * An exception that is thrown if an FTP command does not execute successfully.
 */
public class FTPFileSystemException extends FileSystemException implements FTPResponse {

    private static final long serialVersionUID = 3914421047186137133L;

    private final int replyCode;

    /**
     * Creates a new {@code FTPFileSystemException}.
     * This constructor should be used when an operation not involving files fails.
     *
     * @param replyCode   The integer value of the reply code of the last FTP reply that triggered this exception.
     * @param replyString The entire text from the last FTP response that triggered this exception. It will be used as the exception's reason.
     */
    public FTPFileSystemException(int replyCode, String replyString) {
        super(null, null, replyString);
        this.replyCode = replyCode;
    }

    /**
     * Creates a new {@code FTPFileSystemException}.
     * This constructor should be used when an operation involving one file fails.
     *
     * @param file        A string identifying the file, or {@code null} if not known.
     * @param replyCode   The integer value of the reply code of the last FTP reply that triggered this exception.
     * @param replyString The entire text from the last FTP response that triggered this exception. It will be used as the exception's reason.
     */
    public FTPFileSystemException(String file, int replyCode, String replyString) {
        super(file, null, replyString);
        this.replyCode = replyCode;
    }

    /**
     * Creates a new {@code FTPFileSystemException}.
     * This constructor should be used when an operation involving two files fails.
     *
     * @param file        A string identifying the file, or {@code null} if not known.
     * @param other       A string identifying the other file, or {@code null} if there isn't another file or if not known.
     * @param replyCode   The integer value of the reply code of the last FTP reply that triggered this exception.
     * @param replyString The entire text from the last FTP response that triggered this exception. It will be used as the exception's reason.
     */
    public FTPFileSystemException(String file, String other, int replyCode, String replyString) {
        super(file, other, replyString);
        this.replyCode = replyCode;
    }

    @Override
    public int getReplyCode() {
        return replyCode;
    }

    @Override
    public String getReplyString() {
        return getReason();
    }
}