JCLO (edu.msudenver.cs:JCLO 1.3.5 API)

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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`getBoolean(String key)` Get a boolean value from the object after parsing.
`byte`	`getByte(String key)` Get a byte value from the object after parsing.
`byte[]`	`getBytes(String key)` Get an array of bytes from the object after parsing.
`char`	`getChar(String key)` Get a character value from the object after parsing.
`char[]`	`getChars(String key)` Get an array of characaters from the object after parsing.
`double`	`getDouble(String key)` Get a double value from the object after parsing.
`double[]`	`getDoubles(String key)` Get an array of doubles from the object after parsing.
`float`	`getFloat(String key)` Get a float value from the object after parsing.
`float[]`	`getFloats(String key)` Get an array of floats from the object after parsing.
`int`	`getInt(String key)` Get an integer value from the object after parsing.
`int[]`	`getInts(String key)` Get an array of integers from the object after parsing.
`long`	`getLong(String key)` Get a long value from the object after parsing.
`long[]`	`getLongs(String key)` Get an array of longs from the object after parsing.
`short`	`getShort(String key)` Get a short value from the object after parsing.
`short[]`	`getShorts(String key)` Get an array of shorts from the object after parsing.
`String`	`getString(String key)` Get a String from the object after parsing.
`String[]`	`getStrings(String key)` Get an array of Strings from the object after parsing.
`Object`	`getValue(String key)` Get the current value of the variable in the object
`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
  - getValue
```
public Object getValue(String key)
```
    Get the current value of the variable in the object
    
    Parameters:
    
    key - the variable name
    
    Returns:
    
    an Object with the value
  - 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
  - getBoolean
```
public boolean getBoolean(String key)
```
    Get a boolean value from the object after parsing.
    
    Parameters:
    
    key - The name of the option.
    
    Returns:
    
    The boolean.
  - getByte
```
public byte getByte(String key)
```
    Get a byte value from the object after parsing.
    
    Parameters:
    
    key - The name of the option.
    
    Returns:
    
    The byte.
  - getChar
```
public char getChar(String key)
```
    Get a character value from the object after parsing.
    
    Parameters:
    
    key - The name of the option.
    
    Returns:
    
    The character.
  - getShort
```
public short getShort(String key)
```
    Get a short value from the object after parsing.
    
    Parameters:
    
    key - The name of the option.
    
    Returns:
    
    The short.
  - getInt
```
public int getInt(String key)
```
    Get an integer value from the object after parsing.
    
    Parameters:
    
    key - The name of the option.
    
    Returns:
    
    The integer.
  - getFloat
```
public float getFloat(String key)
```
    Get a float value from the object after parsing.
    
    Parameters:
    
    key - The name of the option.
    
    Returns:
    
    The float.
  - getDouble
```
public double getDouble(String key)
```
    Get a double value from the object after parsing.
    
    Parameters:
    
    key - The name of the option.
    
    Returns:
    
    The double.
  - getLong
```
public long getLong(String key)
```
    Get a long value from the object after parsing.
    
    Parameters:
    
    key - The name of the option.
    
    Returns:
    
    The long.
  - getString
```
public String getString(String key)
```
    Get a String from the object after parsing.
    
    Parameters:
    
    key - The name of the option.
    
    Returns:
    
    The String.
  - getBytes
```
public byte[] getBytes(String key)
```
    Get an array of bytes from the object after parsing.
    
    Parameters:
    
    key - The name of the option.
    
    Returns:
    
    The array of bytes.
  - getChars
```
public char[] getChars(String key)
```
    Get an array of characaters from the object after parsing.
    
    Parameters:
    
    key - The name of the option.
    
    Returns:
    
    The array of characters.
  - getShorts
```
public short[] getShorts(String key)
```
    Get an array of shorts from the object after parsing.
    
    Parameters:
    
    key - The name of the option.
    
    Returns:
    
    The array of shorts.
  - getInts
```
public int[] getInts(String key)
```
    Get an array of integers from the object after parsing.
    
    Parameters:
    
    key - The name of the option.
    
    Returns:
    
    The array of integers.
  - getFloats
```
public float[] getFloats(String key)
```
    Get an array of floats from the object after parsing.
    
    Parameters:
    
    key - The name of the option.
    
    Returns:
    
    The array of floats.
  - getDoubles
```
public double[] getDoubles(String key)
```
    Get an array of doubles from the object after parsing.
    
    Parameters:
    
    key - The name of the option.
    
    Returns:
    
    The array of doubles.
  - getLongs
```
public long[] getLongs(String key)
```
    Get an array of longs from the object after parsing.
    
    Parameters:
    
    key - The name of the option.
    
    Returns:
    
    The array of longs.
  - getStrings
```
public String[] getStrings(String key)
```
    Get an array of Strings from the object after parsing.
    
    Parameters:
    
    key - The name of the option.
    
    Returns:
    
    The array of Strings.
  - main
```
public static void main(String[] args)
                 throws IOException
```
    Throws:
    
    IOException

Class JCLO

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JCLO

JCLO

JCLO

JCLO

Method Detail

getValue

toString

usage

parse

getBoolean

getByte

getChar

getShort

getInt

getFloat

getDouble

getLong

getString

getBytes

getChars

getShorts

getInts

getFloats

getDoubles

getLongs

getStrings

main