edu.msudenver.cs.jclo

Class JCLO

java.lang.Object

edu.msudenver.cs.jclo.JCLO

public class JCLO
extends Object

This class is used to parse command-line arguments based on a the variables with an object. Each variable in the class specifies a command-line argument that can be accepted; the name of the variable becomes the name of the command-line argument. As Java does not allow dashes '-' in variables, use two underscores '__' if you want a dash in an argument. Also, if you want to have a numeric argument (e.g.: '-1'), start the variable name with a single underscore. JCLO uses reflection to determine the type of each variable in the passed object and sets the values in the object passed to it via parsing the command line. If you include a String array named "additional", all non-dashed arguments will be placed in it.

Author:

Steve Beaty (beatys@mscd.edu) @version $Id: JCLO.java,v 1.5 2007/11/01 16:43:12 beaty Exp beaty $

Constructor Summary

Constructors

Constructor and Description
JCLO(Object object) A constructor that takes the Object that contains the variables acceptable on a command line.
JCLO(Object object, String[][] aliases) A constructor that takes the Object that contains the variables acceptable on a command line.
JCLO(String prefix, Object object) A constructor that takes the Object that contains the variables acceptable on a command line.
JCLO(String prefix, Object object, String[][] aliases) A constructor that takes an Object, a prefix, and a boolean that specifies whether to accept single or double dashes; call parse (String) to do the actual parsing.

Method Summary

Modifier and Type	Method and Description
static void	main(String[] args)
void	parse(String[] args) Parse a command line.
String	toString() An external representation of the object
String	usage() Create and usage message for the acceptable command line variables.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

JCLO

public JCLO(Object object)

A constructor that takes the Object that contains the variables acceptable on a command line. Call parse (String) to do the actual parsing.

Parameters:

object - where the variables/arguments are

JCLO

public JCLO(Object object,
            String[][] aliases)

A constructor that takes the Object that contains the variables acceptable on a command line. Call parse (String) to do the actual parsing.

Parameters:

object - where the variables/arguments are

aliases - if there are CLO aliases

JCLO

public JCLO(String prefix,
            Object object)

A constructor that takes the Object that contains the variables acceptable on a command line. Call parse (String) to do the actual parsing.

Parameters:

object - where the variables/arguments are

prefix - if all CLO variables start with a prefix

JCLO

public JCLO(String prefix,
            Object object,
            String[][] aliases)

A constructor that takes an Object, a prefix, and a boolean that specifies whether to accept single or double dashes; call parse (String) to do the actual parsing.

Parameters:

object - where the variables/arguments are

prefix - the String CLO's start with, if any

aliases - if there are CLO aliases

Method Detail

toString

public String toString()

An external representation of the object

Overrides:

toString in class Object

Returns:

a formatted version of this object

usage

public String usage()

Create and usage message for the acceptable command line variables.

Returns:

a String that specifies acceptable options

parse

public void parse(String[] args)

Parse a command line.

Parameters:

args - the arguments to be parsed

main

public static void main(String[] args)
                 throws IOException

Throws:

IOException