Options.java

/*
 * Copyright 1999-2006 University of Chicago
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.dcache.ftp.client;

/**
 * Represents FTP command options, as defined in RFC 2389.
 */
public abstract class Options
{

    protected final String command;

    /**
     * @param cmd command whose options are represent by this object
     */
    public Options(String cmd)
    {
        command = cmd;
    }

    public String toFtpCmdArgument()
    {
        return command + " " + getArgument();
    }

    /**
     * Subclasses should implement this method. It should
     * return the right side of the options line,
     * in the format of OPTS command. It should not include the
     * command name.
     */
    public abstract String getArgument();

}