com.lafaspot.pop.command.PopCommand Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of popclient Show documentation
Asynchronous POP client.
The newest version!
/**
 *
 */
package com.lafaspot.pop.command;

import java.util.ArrayList;
import java.util.List;

import javax.annotation.Nonnull;

import com.lafaspot.pop.session.PopFuture;

/**
 * Pop command.
 *
 * @author kraman
 *
 */
public class PopCommand {
    /** Command type. */
    private final Type type;
    /** Arguments. */
    private final List args;

    /** Response. */
    private final PopCommandResponse response;

    /** future for this command. */
    private PopFuture commandFuture;

    /** The command type as string. */
    private final String typeStr;

    /**
     * Constructor.
     *
     * @param type
     *            command type
     */
    public PopCommand(@Nonnull final Type type) {
        this.type = type;
        this.typeStr = type.name();
        this.args = new ArrayList();
        this.response = new PopCommandResponse(this);
    }

    /**
     * Generic command constructor.
     *
     * @param typeStr
     *            command as string
     * @param type
     *            comamnd type
     * @param args
     *            list of arguments
     */
    public PopCommand(@Nonnull final String typeStr, @Nonnull final Type type, @Nonnull final List args) {
        this.type = type;
        this.typeStr = typeStr;
        this.args = args;
        this.response = new PopCommandResponse(this);
    }

    /**
     * @return the commandFuture
     */
    public PopFuture getCommandFuture() {
        return commandFuture;
    }

    /**
     * @param commandFuture
     *            the commandFuture to set
     */
    public void setCommandFuture(@Nonnull final PopFuture commandFuture) {
        this.commandFuture = commandFuture;
    }

    /**
     * Add optional arguments.
     *
     * @param arg
     *            arguments
     * @return this command for chaining
     */
    public PopCommand addArgs(@Nonnull final String arg) {
        args.add(arg);
        return this;
    }

    /**
     * Get the command line for this command - the line to be sent over wire.
     *
     * @return command line
     */
    public String getCommandLine() {
        final StringBuffer buf = new StringBuffer();
        buf.append(typeStr);
        if (args.size() > 0) {
            for (final String arg : args) {
                buf.append(" ");
                buf.append(arg);
            }
        }
        buf.append("\n");
        return buf.toString();
    }

    /**
     * Get the command type.
     *
     * @return command type
     */
    public Type getType() {
        return type;
    }

    /**
     * Get command response.
     *
     * @return command response
     */
    public PopCommandResponse getResponse() {
        return response;
    }

    /**
     * Return the String equivalent of this command.
     *
     * @return the string value
     */
    @Override
    public String toString() {
        return getCommandLine();
    }

    /**
     * Pop command type enum.
     *
     * @author kraman
     *
     */
    public enum Type {
        /** Invalid command - used for connect activity. */
        INVALID_POP_COMMAND_CONNECT(0, false),
        /** User command. */
        USER(1, false),
        /** Pass command. */
        PASS(2, false),
        /** Stat command. */
        STAT(3, false),
        /** List command. */
        LIST(4, true),
        /** Retr command. */
        RETR(5, true),
        /** Dele command. */
        DELE(6, false),
        /** Noop command. */
        NOOP(7, false),
        /** Rset command. */
        RSET(8, false),
        /** Top comamnd. */
        TOP(9, true),
        /** Uidl command. */
        UIDL(10, true),
        /** Uidl command. */
        QUIT(11, false),
        /** Capa command. */
        CAPA(12, true),
        /** Auth command. */
        AUTH(13, false),
        /** Last command. */
        LAST(14, false),
        /** Generic string command, make it non-multiline. */
        GENERIC_STRING_COMMAND_SINGLELINE(15, false),
        /** Generic string command, make it multiline. */
        GENERIC_STRING_COMMAND_MULTILINE(15, true);

        /** Is this command multiline. */
        private final boolean multiLine;
        /** Command type. */
        private final int type;

        /**
         * Constructor.
         *
         * @param type
         *            command type
         * @param multiLine
         *            is this multiline command
         */
        Type(final int type, final boolean multiLine) {
            this.type = type;
            this.multiLine = multiLine;
        }

        /**
         * Get if this is a multiline command.
         *
         * @return is this multiline command
         */
        public boolean multiLine() {
            return multiLine;
        }

        /**
         * Convert string to command type.
         *
         * @param typeStr
         *            string representing command
         * @return command type
         */
        public static Type valueFromString(@Nonnull final String typeStr) {
            Type ret;
            try {
                ret = valueOf(typeStr.toUpperCase());
            } catch (final IllegalArgumentException e) {
                ret = Type.GENERIC_STRING_COMMAND_SINGLELINE;
            }
            return ret;
        }
    }

}