/*
 * Copyright (c) 2008, Heng Yuan
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the Heng Yuan nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY Heng Yuan ''AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL Heng Yuan BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.yuanheng.cookcc.interfaces;

/**
 * OptionParser is used in parsing user command line arguments.
 * It's toString () function is used to print usage.
 *
 * @author Heng Yuan
 * @version $Id: OptionHandler.java 482 2008-11-09 12:18:31Z superduperhengyuan $
 */
public interface OptionHandler
{
	/**
	 * Indicates the option string
	 * @return	the option string
	 */
	public String getOption ();

	/**
	 * Indicates whether or not this option requires an argument.
	 *
	 * @return whether or not this option requires an argument.
	 */
	public boolean requireArguments ();

	/**
	 * This function parses the argument at the current index.
	 * If this function recognizes the argument, it would return
	 * the number of arguments being read.  Otherwise, just return
	 * 0 to indicate that it was not handled.
	 *
	 * @param	value
	 *			the argument for the option
	 * @throws	Exception
	 *			in case of error.
	 */
	public void handleOption (String value) throws Exception;
}
