Java Doc for Parser.java in  » Open-Source-Library » Apache-command-line » org » apache » commons » cli » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. JDK Core
2. JDK Modules
3. JDK Modules com.sun
4. JDK Modules com.sun.java
5. JDK Modules Platform
6. JDK Modules sun
7. Open Source Build
8. Open Source Graphic Library
9. Open Source IDE Eclipse
10. Open Source J2EE
11. Open Source JDBC Driver
12. Open Source Library
13. Open Source Library Database
14. Open Source Net
15. Open Source Script
16. Science
17. Security
18. Sevlet Container
19. SUN GlassFish
20. Swing Library
21. Web Services apache cxf 2.0.1
22. Web Services AXIS2
23. XML
Microsoft Office Word 2007 Tutorial
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
C# / C Sharp
C# / CSharp Tutorial
ASP.Net
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
PHP
Python
SQL Server / T-SQL
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Java Source Code / Java Documentation » Open Source Library » Apache command line » org.apache.commons.cli 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.commons.cli.Parser

All known Subclasses:   org.apache.commons.cli.GnuParser,  org.apache.commons.cli.BasicParser,  org.apache.commons.cli.PosixParser,
Parser
abstract public class Parser implements CommandLineParser(Code)

Parser creates CommandLine s.


author:
   John Keyes (john at integralsource.com)
See Also:   Parser
version:
   $Revision: 551815 $




Method Summary
abstract protected  String[]flatten(Options opts, String[] arguments, boolean stopAtNonOption)
    
public  CommandLineparse(Options options, String[] arguments)
    
public  CommandLineparse(Options options, String[] arguments, Properties properties)
     Parse the arguments according to the specified options and properties.
public  CommandLineparse(Options options, String[] arguments, boolean stopAtNonOption)
    

Parses the specified arguments based on the specifed Options .


Parameters:
  options - the Options
Parameters:
  arguments - the arguments
Parameters:
  stopAtNonOption - specifies whether to stop interpreting the arguments when a non option has been encountered and to add them to the CommandLinesargs list.
public  CommandLineparse(Options options, String[] arguments, Properties properties, boolean stopAtNonOption)
     Parse the arguments according to the specified options and properties.
Parameters:
  options - the specified Options
Parameters:
  arguments - the command line arguments
Parameters:
  properties - command line option name-value pairs
Parameters:
  stopAtNonOption - stop parsing the arguments when the firstnon option is encountered.
public  voidprocessArgs(Option opt, ListIterator iter)
    

Process the argument values for the specified Option opt using the values retrieved from the specified iterator iter.




Method Detail
flatten
abstract protected String[] flatten(Options opts, String[] arguments, boolean stopAtNonOption)(Code)

Subclasses must implement this method to reduce the arguments that have been passed to the parse method.


Parameters:
  opts - The Options to parse the arguments by.
Parameters:
  arguments - The arguments that have to be flattened.
Parameters:
  stopAtNonOption - specifies whether to stop flattening when a non option has been encountered a String array of the flattened arguments



parse
public CommandLine parse(Options options, String[] arguments) throws ParseException(Code)

Parses the specified arguments based on the specifed Options .


Parameters:
  options - the Options
Parameters:
  arguments - the arguments the CommandLine
throws:
  ParseException - if an error occurs when parsing thearguments.



parse
public CommandLine parse(Options options, String[] arguments, Properties properties) throws ParseException(Code)
Parse the arguments according to the specified options and properties.
Parameters:
  options - the specified Options
Parameters:
  arguments - the command line arguments
Parameters:
  properties - command line option name-value pairs the list of atomic option and value tokens
throws:
  ParseException - if there are any problems encounteredwhile parsing the command line tokens.



parse
public CommandLine parse(Options options, String[] arguments, boolean stopAtNonOption) throws ParseException(Code)

Parses the specified arguments based on the specifed Options .


Parameters:
  options - the Options
Parameters:
  arguments - the arguments
Parameters:
  stopAtNonOption - specifies whether to stop interpreting the arguments when a non option has been encountered and to add them to the CommandLinesargs list. the CommandLine
throws:
  ParseException - if an error occurs when parsing thearguments.



parse
public CommandLine parse(Options options, String[] arguments, Properties properties, boolean stopAtNonOption) throws ParseException(Code)
Parse the arguments according to the specified options and properties.
Parameters:
  options - the specified Options
Parameters:
  arguments - the command line arguments
Parameters:
  properties - command line option name-value pairs
Parameters:
  stopAtNonOption - stop parsing the arguments when the firstnon option is encountered. the list of atomic option and value tokens
throws:
  ParseException - if there are any problems encounteredwhile parsing the command line tokens.



processArgs
public void processArgs(Option opt, ListIterator iter) throws ParseException(Code)

Process the argument values for the specified Option opt using the values retrieved from the specified iterator iter.
Parameters:
  opt - The current Option
Parameters:
  iter - The iterator over the flattened command lineOptions.
throws:
  ParseException - if an argument value is requiredand it is has not been found.




Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

w__w__w__._j__a_v___a2s.___co__m_ | Contact Us
Copyright 2003 - 08 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.