net.sourceforge.nite.meta.impl
Class NiteCallableProgram

java.lang.Object
  extended by net.sourceforge.nite.meta.impl.NiteCallableProgram
All Implemented Interfaces:
NCallableProgram

public class NiteCallableProgram
extends java.lang.Object
implements NCallableProgram

Describes an external program that can be called on this corpus

Author:
jonathan

Nested Class Summary
 class NiteCallableProgram.Argument
           
 
Constructor Summary
NiteCallableProgram(java.lang.String name, java.lang.String description)
           
 
Method Summary
 void addOptionalArgument(java.lang.String flag, java.lang.String type, java.lang.String defaultValue)
           
 void addRequiredArgument(java.lang.String flag, java.lang.String type, java.lang.String defaultValue)
           
 java.lang.String getDescription()
          returns a short description of the program
 java.lang.String getName()
          returns the file name of the program
 java.util.List getOptionalArguments()
          Returns a List of optional "Argument"s belonging to this coding, in arbitrary order
 java.util.List getRequiredArguments()
          Returns a List of required "Argument"s belonging to this coding, in arbitrary order
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

NiteCallableProgram

public NiteCallableProgram(java.lang.String name,
                           java.lang.String description)
Method Detail

getName

public java.lang.String getName()
returns the file name of the program

Specified by:
getName in interface NCallableProgram

getDescription

public java.lang.String getDescription()
returns a short description of the program

Specified by:
getDescription in interface NCallableProgram

getRequiredArguments

public java.util.List getRequiredArguments()
Returns a List of required "Argument"s belonging to this coding, in arbitrary order

Specified by:
getRequiredArguments in interface NCallableProgram

getOptionalArguments

public java.util.List getOptionalArguments()
Returns a List of optional "Argument"s belonging to this coding, in arbitrary order

Specified by:
getOptionalArguments in interface NCallableProgram

addRequiredArgument

public void addRequiredArgument(java.lang.String flag,
                                java.lang.String type,
                                java.lang.String defaultValue)

addOptionalArgument

public void addOptionalArgument(java.lang.String flag,
                                java.lang.String type,
                                java.lang.String defaultValue)