ICommandLineParser.java

/*
 * Software Name : ATK
 *
 * Copyright (C) 2007 - 2012 France Télécom
 *
 * 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.
 * 
 * ------------------------------------------------------------------
 * File Name   : ICommandLineParser.java
 *
 * Created     : 16/02/2007
 * Author(s)   : Nicolas MOTEAU
 */
package com.orange.atk.atkUI.corecli;

/**
 * ICommandLineParser allows adding own command line options from other plugins.
 * It is an extension point of the corecli plugin.
 * 
 * @author Nicolas MOTEAU
 * @since JDK5.0
 */
public interface ICommandLineParser {

	CommandLine parse(String[] args);

	/**
	 * Gets back the synopsis of the command line
	 * 
	 * @return
	 */
	String getSynopsis();

}