iNamik
  The Pursuit of Excellence in the Software Development Lifecycle
 
Home
Projects
Downloads
FAQ
Old News
About
Links
Contact
 
iNamik GetOpt

What Is It?
iNamik GetOpt is a command-line processing tool. It takes an XML file that describes your application's options and generates a command-line processor, a config class to store the options, and will eventually generate useful documentation.

The config class will be built in such a way as to allow you to programmatically specify a configuration (as apposed to only allowing configuration from the command line).

Currently, iNamik GetOpt "eats it's own dog food" in that the Main and Config classes that it uses to operate were generated using GetOpt itself

How Do I Use It?
Look at GetOpt.xml for an example of what the XML configuraiton file should look like. Basically each option gets:

Name Description
name Long name of the option. Seperate logical words with "_", " " or "-" (i.e. long_opt).
short Short (1 char) alias for the option
type
  • boolean
  • integer
  • string
  • input-file (verifies that file exists)
  • input-dir (verifies that dir exists)
  • output-file (treated as string for now)
  • ouput-dir (treated as string for now)
required
  • yes
  • no
default A default value appropriate for the type

Todo
  • Express/Enforce inter-option relationsips
  • Support multiple occurrences of an option (i.e. 'list' type)
  • Support name-value pairs (i.e. 'map' type)
  • Support named operands
  • Generate Useful Documentation (html, javadoc, etc)

What License Is It Released Under?
iNamik GetOpt is currently released under the GNU General Public License .