org.lineargs.LineArgsParser Class Reference

Command line arguments parser implementation. More...

List of all members.

Public Member Functions

 LineArgsParser ()
 Constructor.

Package Functions

public< T > T parse (Class< T > objClass, String args[]) throws Exception
 Do parse arguments.
public< T > T parse (T object, String args[]) throws Exception
 Do parse arguments.
public< T > void printHelp (Class< T > objClass, PrintStream stream) throws Exception
 Print to stream help for specified options.


Detailed Description

Command line arguments parser implementation.


Member Function Documentation

public<T> T org.lineargs.LineArgsParser.parse ( Class< T >  objClass,
String  args[] 
) throws Exception [package]

Do parse arguments.

Example:

   public class MyClass {
      @StringOption (name = "--optionName", description = "option description")
      String myOption = null;
      
      void setMyOption(String option) {...};
      String getMyOption(void) {...};
      
   }
   ...
   // Creating parser
   LineArgsParser parser = new LineArgsParser();
   
   // do parse
   MyClass object = parser.parse(MyClass.class,args);
Parameters:
objClass An object class which contains of annotated properties.
args Command line arguments
Returns:
Object which contains a filled properties

public<T> T org.lineargs.LineArgsParser.parse ( object,
String  args[] 
) throws Exception [package]

Do parse arguments.

Example:

   public class MyClass {
      @StringOption (name = "--optionName", description = "option description")
      String myOption = null;
      
      void setMyOption(String option) {...};
      String getMyOption(void) {...};
      
   }
   ...
   // Creating parser
   LineArgsParser parser = new LineArgsParser();
   // Manual created object
   MyClass object = new MyClass();
   // do parse
   parser.parse(MyClass,args);
Parameters:
object An object which contains of annotated properties.
args Command line arguments
Returns:
Object which contains a filled properties

public<T> void org.lineargs.LineArgsParser.printHelp ( Class< T >  objClass,
PrintStream  stream 
) throws Exception [package]

Print to stream help for specified options.

Example:

   parser.printHelp(MyClass.class,System.out);
Parameters:
objClass An object which contains of annotated properties.
stream Stream to write help


Generated on Fri Feb 9 00:59:59 2007 for LineArgs by  doxygen 1.5.0