A B C D E F G I L M N O P S T U
All Classes All Packages

## A

AbortException - Exception in uk.ac.starlink.task
  Exception generated when the user signals an intention to abort a task.
AbortException() - Constructor for exception uk.ac.starlink.task.AbortException
AbortException(String) - Constructor for exception uk.ac.starlink.task.AbortException
AbortException(String, Throwable) - Constructor for exception uk.ac.starlink.task.AbortException
AbortException(Throwable) - Constructor for exception uk.ac.starlink.task.AbortException
acquireValue(Parameter<?>) - Method in interface uk.ac.starlink.task.Environment
  Obtains a legal value for a given parameter from the environment and sets the parameter's value accordingly.
acquireValue(Parameter<?>) - Method in class uk.ac.starlink.task.LineEnvironment
acquireValue(Parameter<?>) - Method in class uk.ac.starlink.task.TerminalEnvironment
  Sets the value of a parameter.
addOption(T) - Method in class uk.ac.starlink.task.ChoiceParameter
  Adds an option value to this parameter.
addOption(T, String) - Method in class uk.ac.starlink.task.ChoiceParameter
  Adds an option value to this parameter with a given name.

## B

BooleanParameter - Class in uk.ac.starlink.task
  Parameter value representing a boolean value.
BooleanParameter(String) - Constructor for class uk.ac.starlink.task.BooleanParameter
  Constructs a new boolean parameter.
booleanValue(Environment) - Method in class uk.ac.starlink.task.BooleanParameter
  Returns the value of this parameter as a boolean.
BY_NAME - Static variable in class uk.ac.starlink.task.Parameter
  Compares parameters alphabetically by parameter name.

## C

checkParameters(Parameter<?>[]) - Method in class uk.ac.starlink.task.LineEnvironment
  Checks that this environment's values are compatible with the given list of parameters.
ChoiceParameter<T> - Class in uk.ac.starlink.task
  Parameter whose legal value must be one of a disjunction of given values.
ChoiceParameter(String, Class<T>) - Constructor for class uk.ac.starlink.task.ChoiceParameter
  Constructs a choice parameter with no initially set options.
ChoiceParameter(String, Class<T>, T[]) - Constructor for class uk.ac.starlink.task.ChoiceParameter
  Constructor.
ChoiceParameter(String, T[]) - Constructor for class uk.ac.starlink.task.ChoiceParameter
  Constructs a choice parameter with an initial option set.
clear(Parameter<?>) - Method in class uk.ac.starlink.task.TerminalEnvironment
clearOptions() - Method in class uk.ac.starlink.task.ChoiceParameter
  Clears the list of known options.
clearValue(Environment) - Method in class uk.ac.starlink.task.Parameter
  Clears the value of this parameter.
clearValue(Parameter<?>) - Method in interface uk.ac.starlink.task.Environment
  Clears a value for a given parameter.
clearValue(Parameter<?>) - Method in class uk.ac.starlink.task.LineEnvironment
clearValue(Parameter<?>) - Method in class uk.ac.starlink.task.TerminalEnvironment
configureLogging(int, boolean) - Static method in class uk.ac.starlink.task.InvokeUtils
  Sets up the logging system.
createExecutable(Environment) - Method in interface uk.ac.starlink.task.Task
  Creates an executable object which will do the work of this task in the given Environment.

## D

DoubleParameter - Class in uk.ac.starlink.task
  Parameter representing a double precision number.
DoubleParameter(String) - Constructor for class uk.ac.starlink.task.DoubleParameter
  Constructor.
doubleValue(Environment) - Method in class uk.ac.starlink.task.DoubleParameter
  Returns the value of this parameter as a `double`.

## E

Environment - Interface in uk.ac.starlink.task
  Defines an execution environment within which tasks can operate.
Executable - Interface in uk.ac.starlink.task
  Defines an object which does the work of a task without any further user or environment interaction.
execute() - Method in interface uk.ac.starlink.task.Executable
  Performs the work defined by this object.
ExecutionException - Exception in uk.ac.starlink.task
  Exception generated when a task does not complete correctly for some known reason.
ExecutionException() - Constructor for exception uk.ac.starlink.task.ExecutionException
ExecutionException(String) - Constructor for exception uk.ac.starlink.task.ExecutionException
ExecutionException(String, int) - Constructor for exception uk.ac.starlink.task.ExecutionException
ExecutionException(String, Throwable) - Constructor for exception uk.ac.starlink.task.ExecutionException
ExecutionException(Throwable) - Constructor for exception uk.ac.starlink.task.ExecutionException

## F

format(LogRecord) - Method in class uk.ac.starlink.task.LineFormatter

## G

getAssignments() - Method in class uk.ac.starlink.task.LineEnvironment
  Returns an array of strings, one for each parameter assignment which was actually used (via `LineEnvironment.acquireValue(uk.ac.starlink.task.Parameter<?>)`) for this environment.
getDescription() - Method in class uk.ac.starlink.task.Parameter
  Returns the textual description for this parameter.
getErrorCode() - Method in exception uk.ac.starlink.task.ExecutionException
getErrorStream() - Method in interface uk.ac.starlink.task.Environment
  Returns an output stream into which error or logging output from a task can be written.
getErrorStream() - Method in class uk.ac.starlink.task.LineEnvironment
getErrorStream() - Method in class uk.ac.starlink.task.TerminalEnvironment
  Returns `System.err`.
getInteractive() - Method in class uk.ac.starlink.task.LineEnvironment
  Determines whether we are running interactively.
getJavaVersion() - Static method in class uk.ac.starlink.task.InvokeUtils
  Returns the JVM version, without throwing any exceptions.
getJavaVM() - Static method in class uk.ac.starlink.task.InvokeUtils
  Returns the JVM name and version string, without throwing any exceptions.
getName() - Method in class uk.ac.starlink.task.LineWord
  Returns the parameter name represented by this word.
getName() - Method in class uk.ac.starlink.task.Parameter
  Returns the name of this parameter.
getName(T) - Method in class uk.ac.starlink.task.ChoiceParameter
  Converts an option value object to a string which is used to identify it as a string value of this parameter.
getNames() - Method in interface uk.ac.starlink.task.Environment
  Returns an array of parameter names which have been specified.
getNames() - Method in class uk.ac.starlink.task.LineEnvironment
getNames() - Method in class uk.ac.starlink.task.TerminalEnvironment
getObjectFactory() - Method in class uk.ac.starlink.task.ObjectFactoryParameter
  Returns the object factory used by this parameter.
getOption(String) - Method in class uk.ac.starlink.task.ChoiceParameter
  Returns the option value associated with a given string by this parameter.
getOptionNames() - Method in class uk.ac.starlink.task.ChoiceParameter
  Returns an array of the string values of options accepted by this parameter.
getOptions() - Method in class uk.ac.starlink.task.ChoiceParameter
  Returns an array of the option objects which may form the values of this parameter.
getOptionValueList() - Method in class uk.ac.starlink.task.ChoiceParameter
  Returns a collection of the option objects which may form the values of this parameter.
getOutputStream() - Method in interface uk.ac.starlink.task.Environment
  Returns an output stream into which text output from a task can be written.
getOutputStream() - Method in class uk.ac.starlink.task.LineEnvironment
getOutputStream() - Method in class uk.ac.starlink.task.TerminalEnvironment
  Returns `System.out`.
getParameter() - Method in exception uk.ac.starlink.task.ParameterValueException
  Returns the parameter with which this exception is associated.
getParameters() - Method in interface uk.ac.starlink.task.Task
  Returns the list of parameters which may be used by this task.
getParamHelp(Parameter<?>) - Method in class uk.ac.starlink.task.LineEnvironment
  Returns the help string for a given parameter.
getPosition() - Method in class uk.ac.starlink.task.Parameter
  Gets the position of this parameter in a parameter list; the first parameter is 1.
getPreferExplicit() - Method in class uk.ac.starlink.task.Parameter
  Determine whether an explict value is generally preferred to the default value for this parameter.
getPrompt() - Method in class uk.ac.starlink.task.Parameter
  Gets the prompt string for this parameter, as displayed to the user when the value of the parameter is requested.
getPromptAll() - Method in class uk.ac.starlink.task.LineEnvironment
  Determines whether all parameters which haven't received explicit values on the command line should be prompted for.
getPurpose() - Method in interface uk.ac.starlink.task.Task
  Returns a short (one-line) description of the purpose of this task.
getStringDefault() - Method in class uk.ac.starlink.task.Parameter
  Gets the default string value for this parameter.
getTaskUsage(Task) - Static method in class uk.ac.starlink.task.TerminalInvoker
  Returns a usage string for a given task.
getText() - Method in class uk.ac.starlink.task.LineWord
  Returns the full text of the original command-line argument.
getUnused() - Method in class uk.ac.starlink.task.LineEnvironment
  Returns a string containing any words of the input argument list which were never queried by the application to find their value.
getUsage() - Method in class uk.ac.starlink.task.ChoiceParameter
  Returns a usage message.
getUsage() - Method in class uk.ac.starlink.task.ObjectFactoryParameter
getUsage() - Method in class uk.ac.starlink.task.Parameter
  Returns the usage string for this parameter.
getUsage() - Method in class uk.ac.starlink.task.SingleTaskInvoker
  Returns a usage string for this invoker.
getValue() - Method in class uk.ac.starlink.task.LineWord
  Returns the parameter value represented by this word.
getValueClass() - Method in class uk.ac.starlink.task.Parameter
  Returns the class of the typed values this parameter takes.
getValueSeparator() - Method in interface uk.ac.starlink.task.MultiParameter
  Returns a character which is to be used as the separator between values found in adjacent occurrences of the parameter in the execution environment.
getVersionMessage() - Method in class uk.ac.starlink.task.MultiTaskInvoker
  Returns the message to be reported if the "-version" flag is given.

## I

INDIRECTION_CHAR - Static variable in class uk.ac.starlink.task.LineEnvironment
InputStreamParameter - Class in uk.ac.starlink.task
  Parameter which can provide an input stream based on its value.
InputStreamParameter(String) - Constructor for class uk.ac.starlink.task.InputStreamParameter
IntegerParameter - Class in uk.ac.starlink.task
  Parameter representing an integer value.
IntegerParameter(String) - Constructor for class uk.ac.starlink.task.IntegerParameter
intValue(Environment) - Method in class uk.ac.starlink.task.IntegerParameter
  Returns the value of this parameter as an int primitive.
invoke(String[]) - Method in class uk.ac.starlink.task.MultiTaskInvoker
  Invokes one of the tasks known by this invoker given a command line.
invoke(String[]) - Method in class uk.ac.starlink.task.SingleTaskInvoker
invoke(String[]) - Method in class uk.ac.starlink.task.TerminalInvoker
  Invokes a method from this TerminalInvoker's class.
InvokeUtils - Class in uk.ac.starlink.task
  Provides some utility functions used by classes which invoke tasks.
InvokeUtils() - Constructor for class uk.ac.starlink.task.InvokeUtils
isHidden(Parameter<?>) - Method in class uk.ac.starlink.task.LineEnvironment
  Determines whether a parameter is "hidden", that is its value should not be revealed to prying eyes.
isNullPermitted() - Method in class uk.ac.starlink.task.Parameter
  Determine whether it is legal for this parameter's value to be blank.

## L

LineEnvironment - Class in uk.ac.starlink.task
  Execution environment for use from the command line.
LineEnvironment() - Constructor for class uk.ac.starlink.task.LineEnvironment
  Constructs a LineEnvironment without any additional initialisation.
LineEnvironment(String[], Parameter<?>[]) - Constructor for class uk.ac.starlink.task.LineEnvironment
  Constructs a new LineEnvironment, initialising it with a set of command line arguments.
LineFormatter - Class in uk.ac.starlink.task
  Compact log record formatter.
LineFormatter(boolean) - Constructor for class uk.ac.starlink.task.LineFormatter
  Constructor.
LineWord - Class in uk.ac.starlink.task
  Represents a single word on the command line used as by LineEnvironment.
LineWord(String) - Constructor for class uk.ac.starlink.task.LineWord
  Constructor.
LongParameter - Class in uk.ac.starlink.task
  Parameter representing a long integer value.
LongParameter(String) - Constructor for class uk.ac.starlink.task.LongParameter
  Constructor.
longValue(Environment) - Method in class uk.ac.starlink.task.LongParameter
  Returns the value of this parameter as long primitive.

## M

main(String[]) - Static method in class uk.ac.starlink.task.InvokeUtils
  Invokes the main method of a named class with logging configuration specified on the command line.
MultiParameter - Interface in uk.ac.starlink.task
  Marker interface which marks a parameter as one which can have multiple appearances on the command line.
MultiTaskInvoker - Class in uk.ac.starlink.task
  Invokes tasks from a command line when the tasks are available from an `ObjectFactory`.
MultiTaskInvoker(String, ObjectFactory<Task>) - Constructor for class uk.ac.starlink.task.MultiTaskInvoker
  Constructor.

## N

NUM_TRIES - Static variable in class uk.ac.starlink.task.LineEnvironment
NUM_TRIES - Static variable in class uk.ac.starlink.task.TerminalEnvironment
  The number of goes you get to put in an invalid parameter.

## O

ObjectFactoryParameter<T> - Class in uk.ac.starlink.task
  Parameter whose (user-supplied) string values correspond to nicknames from an `ObjectFactory`.
ObjectFactoryParameter(String, ObjectFactory<T>) - Constructor for class uk.ac.starlink.task.ObjectFactoryParameter
  Constructor.
objectToString(Environment, T) - Method in class uk.ac.starlink.task.ChoiceParameter
objectToString(Environment, T) - Method in class uk.ac.starlink.task.Parameter
  Takes a typed value of this parameter and formats it as a string which may be used for presentation to the user.
objectValue(Environment) - Method in class uk.ac.starlink.task.Parameter
  Gets the value of this parameter as a typed object.
OutputStreamParameter - Class in uk.ac.starlink.task
  Parameter for selecting an output stream to write to.
OutputStreamParameter(String) - Constructor for class uk.ac.starlink.task.OutputStreamParameter
  Constructor.

## P

Parameter<T> - Class in uk.ac.starlink.task
  A Parameter describes the function of one of a task's parameters.
Parameter(String, Class<T>, boolean) - Constructor for class uk.ac.starlink.task.Parameter
  Constructs a parameter with a given name.
ParameterValueException - Exception in uk.ac.starlink.task
  Exception generated when the value of a parameter is invalid.
ParameterValueException(Parameter<?>) - Constructor for exception uk.ac.starlink.task.ParameterValueException
ParameterValueException(Parameter<?>, String) - Constructor for exception uk.ac.starlink.task.ParameterValueException
ParameterValueException(Parameter<?>, String, Throwable) - Constructor for exception uk.ac.starlink.task.ParameterValueException
ParameterValueException(Parameter<?>, Throwable) - Constructor for exception uk.ac.starlink.task.ParameterValueException
paramNameMatches(String, Parameter<?>) - Method in class uk.ac.starlink.task.LineEnvironment
  Indicates whether a parameter name supplied from the environment is a reference to a given parameter.

## S

setBooleanDefault(boolean) - Method in class uk.ac.starlink.task.BooleanParameter
  Sets the default as a boolean value.
setDefaultOption(T) - Method in class uk.ac.starlink.task.ChoiceParameter
  Sets the default value for this parameter to one of the previously added options.
setDescription(String) - Method in class uk.ac.starlink.task.Parameter
  Sets the textual description for this parameter.
setDescription(String[]) - Method in class uk.ac.starlink.task.Parameter
  Convenience method to set the description for this parameter by the result of joining an array of lines together.
setDoubleDefault(double) - Method in class uk.ac.starlink.task.DoubleParameter
  Sets the default value as a floating point value.
setErrorCode(int) - Method in exception uk.ac.starlink.task.ExecutionException
setErrorStream(PrintStream) - Method in class uk.ac.starlink.task.LineEnvironment
  Sets the destination stream for standard error.
setEven() - Method in class uk.ac.starlink.task.IntegerParameter
  Mandates that any value of this parameter must be even.
setIntDefault(int) - Method in class uk.ac.starlink.task.IntegerParameter
  Sets the default value as an integer.
setInteractive(boolean) - Method in class uk.ac.starlink.task.LineEnvironment
  Sets whether we are running interactively or not.
setMaximum(double, boolean) - Method in class uk.ac.starlink.task.DoubleParameter
  Sets the maximum acceptable value for this parameter.
setMaximum(int) - Method in class uk.ac.starlink.task.IntegerParameter
  Mandates a maximum value for this parameter.
setMaximum(long) - Method in class uk.ac.starlink.task.LongParameter
  Mandates a maximum value for this parameter.
setMinimum(double, boolean) - Method in class uk.ac.starlink.task.DoubleParameter
  Sets the minimum acceptable value for this parameter.
setMinimum(int) - Method in class uk.ac.starlink.task.IntegerParameter
  Mandates a minimum value for this parameter.
setMinimum(long) - Method in class uk.ac.starlink.task.LongParameter
  Mandates a minimum value for this parameter.
setName(String) - Method in class uk.ac.starlink.task.Parameter
  Sets the name of this parameter.
setNullPermitted(boolean) - Method in class uk.ac.starlink.task.Parameter
  Set whether it is legal for this parameter's value to be blank.
setOdd() - Method in class uk.ac.starlink.task.IntegerParameter
  Mandates that any value of this parameter must be odd.
setOutputStream(PrintStream) - Method in class uk.ac.starlink.task.LineEnvironment
  Sets the destination stream for standard out.
setPosition(int) - Method in class uk.ac.starlink.task.Parameter
  Sets the position of this parameter in a parameter list; the first parameter is 1.
setPreferExplicit(boolean) - Method in class uk.ac.starlink.task.Parameter
  Set whether an explicit value is generally to be solicited from the user rather than taking the default.
setPrompt(String) - Method in class uk.ac.starlink.task.Parameter
  Sets the prompt string for this parameter, as displayed to the user when the value of the parameter is requested.
setPromptAll(boolean) - Method in class uk.ac.starlink.task.LineEnvironment
  Sets whether all parameters which haven't received explicit values on the command line should be prompted for.
setStringDefault(String) - Method in class uk.ac.starlink.task.Parameter
  Sets the default string value for this parameter.
setUsage(String) - Method in class uk.ac.starlink.task.ChoiceParameter
setUsage(String) - Method in class uk.ac.starlink.task.Parameter
  Sets a usage string for this parameter.
setValue(String, T) - Method in class uk.ac.starlink.task.Parameter
  Sets the value of this parameter without any additional validation.
setValueFromObject(Environment, T) - Method in class uk.ac.starlink.task.Parameter
  Sets the value of this parameter directly from a typed object.
setValueFromString(Environment, String) - Method in class uk.ac.starlink.task.DoubleParameter
  As a special case, setting the value of this parameter with a null or empty string will result in a NaN value.
setValueFromString(Environment, String) - Method in class uk.ac.starlink.task.Parameter
  Sets the value of this parameter from a String.
setVersionMessage(String) - Method in class uk.ac.starlink.task.MultiTaskInvoker
  Sets the message which will be reported if the "-version" flag is given.
setWords(LineWord[]) - Method in class uk.ac.starlink.task.LineEnvironment
  Sets the words supplying the parameter values for this environment.
SingleTaskInvoker - Class in uk.ac.starlink.task
  Invoker which only knows how to invoke a single given task.
SingleTaskInvoker(Task, String) - Constructor for class uk.ac.starlink.task.SingleTaskInvoker
  Constructor.
sortParameters(Parameter<?>[]) - Static method in class uk.ac.starlink.task.InvokeUtils
  Sorts a list of Parameter objects.
stringifyOption(T) - Method in class uk.ac.starlink.task.ChoiceParameter
  Determines how an option will be represented as a string value of this parameter if no name has explicitly been supplied.
StringParameter - Class in uk.ac.starlink.task
  Parameter for holding string values.
StringParameter(String) - Constructor for class uk.ac.starlink.task.StringParameter
  Constructor.
stringToObject(Environment, String) - Method in class uk.ac.starlink.task.BooleanParameter
stringToObject(Environment, String) - Method in class uk.ac.starlink.task.ChoiceParameter
stringToObject(Environment, String) - Method in class uk.ac.starlink.task.DoubleParameter
stringToObject(Environment, String) - Method in class uk.ac.starlink.task.InputStreamParameter
stringToObject(Environment, String) - Method in class uk.ac.starlink.task.IntegerParameter
stringToObject(Environment, String) - Method in class uk.ac.starlink.task.LongParameter
stringToObject(Environment, String) - Method in class uk.ac.starlink.task.ObjectFactoryParameter
stringToObject(Environment, String) - Method in class uk.ac.starlink.task.OutputStreamParameter
stringToObject(Environment, String) - Method in class uk.ac.starlink.task.Parameter
  Takes a non-blank string, as supplied by the execution environment, and turns it into a typed value for this parameter.
stringToObject(Environment, String) - Method in class uk.ac.starlink.task.StringParameter
stringToObject(Environment, String) - Method in class uk.ac.starlink.task.URLParameter
stringValue(Environment) - Method in class uk.ac.starlink.task.Parameter
  Gets the value of this parameter as a String.
summariseError(Throwable, PrintStream) - Static method in class uk.ac.starlink.task.InvokeUtils
  Writes a summary of a (possibly nested) exception to a given output stream.

## T

Task - Interface in uk.ac.starlink.task
  Defines a user-level task.
TaskException - Exception in uk.ac.starlink.task
  Superclass for exceptions in the task package.
TaskException() - Constructor for exception uk.ac.starlink.task.TaskException
TaskException(String) - Constructor for exception uk.ac.starlink.task.TaskException
TaskException(String, Throwable) - Constructor for exception uk.ac.starlink.task.TaskException
TaskException(Throwable) - Constructor for exception uk.ac.starlink.task.TaskException
TerminalEnvironment - Class in uk.ac.starlink.task
  Implementation of Environment which accepts an initial command line, and communicates with the user using standard input and standard output.
TerminalEnvironment(String[], Parameter<?>[]) - Constructor for class uk.ac.starlink.task.TerminalEnvironment
  Constructs a new Environment based on a String array containing supplied arguments, and a list of parameters which may be encountered.
TerminalInvoker - Class in uk.ac.starlink.task
  Invokes Task objects in a way suitable for use from the `main` method, using a command line interface.
TerminalInvoker(String, Map<String, Task>) - Constructor for class uk.ac.starlink.task.TerminalInvoker
  Creates a new invoker based on the given class with a given name.
toArray(Collection<T>) - Method in class uk.ac.starlink.task.Parameter
  Utility function to convert a list to an array, where the elements are of the value class of this parameter.
toString() - Method in class uk.ac.starlink.task.LineWord
toString() - Method in class uk.ac.starlink.task.Parameter
  Returns the name of this parameter.

## U

uk.ac.starlink.task - package uk.ac.starlink.task
  A framework for invoking user-level tasks.
URLParameter - Class in uk.ac.starlink.task
  Parameter representing a URL value.
URLParameter(String) - Constructor for class uk.ac.starlink.task.URLParameter
  Constructor.
UsageException - Exception in uk.ac.starlink.task
  An Exception thrown when a task is invoked with the wrong usage.
UsageException() - Constructor for exception uk.ac.starlink.task.UsageException
UsageException(String) - Constructor for exception uk.ac.starlink.task.UsageException
UsageException(String, Throwable) - Constructor for exception uk.ac.starlink.task.UsageException
UsageException(Throwable) - Constructor for exception uk.ac.starlink.task.UsageException

A B C D E F G I L M N O P S T U
All Classes All Packages