com.svincent.util
Class CommandLine.Arg

java.lang.Object
  |
  +--com.svincent.util.CommandLine.Arg
All Implemented Interfaces:
java.lang.Comparable
Direct Known Subclasses:
CommandLine.BooleanArg, CommandLine.IntArg, CommandLine.StringArg
Enclosing class:
CommandLine

public abstract static class CommandLine.Arg
extends java.lang.Object
implements java.lang.Comparable

An Arg represents the definition of a potential argument on the command line.


Constructor Summary
CommandLine.Arg(java.lang.String _longName)
           
 
Method Summary
 int compareTo(java.lang.Object _that)
           
 CommandLine.Arg description(java.lang.String s)
           
abstract  int getArgCount()
           
 java.lang.String getDescription()
           
 java.lang.String getLongName()
           
 java.lang.String getShortName()
           
 boolean isRequired()
           
abstract  void parse(java.lang.String[] args, int index)
           
 void printTypicalUsage(java.io.PrintWriter out)
           
 CommandLine.Arg required()
           
 CommandLine.Arg shortName(char c)
           
 java.lang.String tag()
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CommandLine.Arg

public CommandLine.Arg(java.lang.String _longName)
Method Detail

required

public CommandLine.Arg required()

shortName

public CommandLine.Arg shortName(char c)

description

public CommandLine.Arg description(java.lang.String s)

isRequired

public boolean isRequired()

getShortName

public java.lang.String getShortName()

getLongName

public java.lang.String getLongName()

getDescription

public java.lang.String getDescription()

compareTo

public int compareTo(java.lang.Object _that)
Specified by:
compareTo in interface java.lang.Comparable

getArgCount

public abstract int getArgCount()

parse

public abstract void parse(java.lang.String[] args,
                           int index)

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

tag

public java.lang.String tag()

printTypicalUsage

public void printTypicalUsage(java.io.PrintWriter out)



This is documentation for Moksa Prolog, which can be found at http://www.svincent.com/moksa/

Copyright © 1999 Shawn P. Vincent.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.