commandline.java

Java Mail Server JAVA编写的邮件服务器

/****************************************************************
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.     *
 *                                                              *
 * Copyright 2008 Jun Li(SiChuan University, the School of      *
 * Software Engineering). All rights reserved.                  *
 *                                                              *
 * Licensed to the JMS under one  or more contributor license   *
 * agreements.  See the LICENCE file  distributed with this     *
 * work for additional information regarding copyright          *
 * ownership.  The JMS licenses this file  you may not use this *
 * file except in compliance  with the License.                 *
 *                                                              *
 * 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.jpxx.mail.Service;

import org.jpxx.mail.Exception.ArgumentException;

/**
 * <p>This is an interface to do with a line of command String.
 * The command line, for example, </p>
 * 
 * <p><i>MAIL FROM:&lt;[e-mail]&gt;<i></p>
 * 
 * 
 * @author Jun Li
 * @version $Revision: 0.0.3 $, $Date: 2008/05/20 $
 * @since JMS 0.0.1
 * 
 */
public interface CommandLine {

    /**
     * Gets command name. A command line includes one comand name and zero 
     * or more arguments. 
     * 
     * @since JMS 0.0.1
     * @return the command name of current line
     */
    public String getName();

    /**
     * Gets argument sting. Returns the left line except command name.
     * It is only for an argument.
     * 
     * @since JMS 0.0.1
     * @return the command argument of current line.
     * @throws org.jpxx.mail.Exception.ArgumentException
     */
    public String getArgument() throws ArgumentException;

    /**
     * Gets the argument <i>num</i>. If num is not efficient, return null object.
     * 
     * @since JMS 0.0.1
     * @param num given argument number
     * @return the given command argument
     * @throws org.jpxx.mail.Exception.ArgumentException
     */
    public String getArgument(int num) throws ArgumentException;
    
    /**
     * Gets the next argument.
     * 
     * @since JMS 0.0.3
     * 
     * @return the given command argument
     * @throws org.jpxx.mail.Exception.ArgumentException
     */
    public String getNextArgument() throws ArgumentException;

    /**
     * <p>Gets the number of arguments.<p>
     * 
     * @since JMS 0.0.3
     * @return the number of arguments.
     */
    public int getArgumentCount();

    /**
     * Gets The line of String
     * @since JMS 0.0.1
     * @return The line of String
     */
    public String getLine();
}