/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 * 
 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 * 
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License. You can obtain
 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
 * or glassfish/bootstrap/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 * 
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
 * Sun designates this particular file as subject to the "Classpath" exception
 * as provided by Sun in the GPL Version 2 section of the License file that
 * accompanied this code.  If applicable, add the following below the License
 * Header, with the fields enclosed by brackets [] replaced by your own
 * identifying information: "Portions Copyrighted [year]
 * [name of copyright owner]"
 * 
 * Contributor(s):
 * 
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */
 
/*
 * $Header: /cvs/glassfish/admin-cli/cli-api/src/java/com/sun/cli/jmx/support/ArgParser.java,v 1.4 2007/05/05 05:24:51 tcfujii Exp $
 * $Revision: 1.4 $
 * $Date: 2007/05/05 05:24:51 $
 */
 

 
package com.sun.cli.jmx.support;

import java.lang.reflect.Array;
import java.util.ArrayList;

public interface ArgParser
{
	public final static char		DEFAULT_ESCAPE_CHAR		= '\\';
	public final static char		DEFAULT_ARG_DELIM		= ',';
	public final static char		DEFAULT_ARRAY_LEFT		= '{';
	public final static char		DEFAULT_ARRAY_RIGHT		= '}';
	
	public final static String		DEFAULT_ESCAPABLE_CHARS_WITHIN_LITERAL_STRING	=
										DEFAULT_ESCAPE_CHAR + "n" + "r" + "t" + "\"";
	
	// note: n, r are for newline, carriage return
	public final static String		DEFAULT_ESCAPABLE_CHARS	=
										DEFAULT_ESCAPABLE_CHARS_WITHIN_LITERAL_STRING +
										",(){}" + "\"" ;
	
	
	/*
		Parse simple names eg a,b,c.
		
		@param input	the string to parse
		@param argDelim	single-character delimiter
		@returns		array of String
	 */
	public String []	ParseNames( String input )
							throws ArgParserException;
							
		
	/*
		Parse the input and return ParseResult [], one for
		each argument.
		
		@param input		the string to parse
		@param namedArgs	true if arguments have names
		@param argDelim		single-character delimiter
		@returns		array of ParseResult
	 */
	public ParseResult []	Parse( String input, boolean namedArgs  )
								throws ArgParserException;
};