All Packages  This Package  Class Hierarchy  Class Search  Index

java.lang.Object
   |
   +----edu.utah.janos.antsr.util.KeyArgs

Summary

public class  KeyArgs
     extends java.lang.Object
{
          // Fields 2
     private KeyArgs.KeyArg[] args;
     private static final KeyArgs.KeyArg empty;

          // Constructors 4
     public KeyArgs() throws InvalidKeyArgsException;
     private KeyArgs(KeyArgs.KeyArg[]);
     public KeyArgs(String[]) throws InvalidKeyArgsException;
     public KeyArgs(String[], int) throws InvalidKeyArgsException;

          // Methods 13
     public String arg(int);
     public void compact();
     public String get(String);
     public String key(int);
     public int length();
     public void merge(KeyArgs);
     public void merge(String[]) throws InvalidKeyArgsException;
     public void merge(String[], int) throws InvalidKeyArgsException;
     public void noMore();
     public void set(String, String);
     public void strike(int);
     public String toString();
     public String[] toStrings();

          // Inner Classes 1
     private static final class KeyArgs.KeyArg
}

Keyword argument manipulation utilities. These are used for handling command line arguments. The key is any string beginning with a "-"; the argument associated with the key can be any string.

WARNING: Do not try to pass an argument value of "-1" to these routines. It will be recognized as a key, not an argument. (Any negative number will do that, of course.)

XXX fix the above, somehow.

Author:

David Wetherall

Fields

· args

Summary  |  Top

   private KeyArgs.KeyArg[] args

Array of KeyArgs, one for each option.

   private static final KeyArgs.KeyArg empty

The canonical 'null argument' KeyArg.

Constructors

· KeyArgs

Summary  |  Top

   private KeyArgs(KeyArgs.KeyArg[] ka) 

   public KeyArgs(String[] ka)  throws InvalidKeyArgsException

   public KeyArgs()  throws InvalidKeyArgsException

   public KeyArgs(String[] ka, 
                  int skip)  throws InvalidKeyArgsException

   public int length() 

Return the number of key/arg pairs.

   public String key(int i) 

Return the i'th key.

   public String arg(int i) 

Return the i'th argument.

   public String get(String key) 

Find the arg associated with the given key. Returns 'null' if the key isn't found.

   public void set(String key, 
                   String arg) 

Set the arg for key. Overwrites existing value for key if one is set, otherwise adds a new pair to the list.

   public void strike(int i) 

Strike the i'th key/arg pair from the list.

   public void compact() 

Compact the list of key/arg pairs. Removes all the "empty" ones.

   public void merge(String[] ka)  throws InvalidKeyArgsException

Merge the given array of strings into the key/arg list.

   public void merge(String[] ka, 
                     int skip)  throws InvalidKeyArgsException

Merge the given array of strings into the key/arg list. The first skip entries in the string array are skipped.

   public void merge(KeyArgs k) 

Merge the given set of KeyArgs into the current list. Duplicates in k are thrown away.

   public String toString() 

Generate a nice, readable string representation of the key/arg pairs.

Overrides:

toString in class Object

   public String[] toStrings() 

Generate an array of Strings, one for each Key/Arg pair.

   public void noMore() 

A handy routine for debugging. Throws an Error if there are any key/value pairs in the current KeyArgs.

All Packages  This Package  Class Hierarchy  Class Search  Index