uk.ac.starlink.ttools.join
Class JoinTypeParameter

java.lang.Object
  extended by uk.ac.starlink.task.Parameter<T>
      extended by uk.ac.starlink.task.ChoiceParameter<JoinType>
          extended by uk.ac.starlink.ttools.join.JoinTypeParameter

public class JoinTypeParameter
extends ChoiceParameter<JoinType>

Parameter which can select a JoinType.

Since:
8 Sep 2005
Author:
Mark Taylor

Field Summary
 
Fields inherited from class uk.ac.starlink.task.Parameter
BY_NAME
 
Constructor Summary
JoinTypeParameter(String name)
           
 
Method Summary
 JoinType joinTypeValue(Environment env)
          Returns the value of this parameter as a JoinType.
 String stringifyOption(JoinType type)
          Determines how an option will be represented as a string value of this parameter if no name has explicitly been supplied.
 
Methods inherited from class uk.ac.starlink.task.ChoiceParameter
addOption, addOption, clearOptions, getName, getOption, getOptionNames, getOptions, getOptionValueList, getUsage, objectToString, setDefaultOption, setUsage, stringToObject
 
Methods inherited from class uk.ac.starlink.task.Parameter
clearValue, getDescription, getName, getPosition, getPreferExplicit, getPrompt, getStringDefault, getValueClass, isNullPermitted, objectValue, setDescription, setDescription, setName, setNullPermitted, setPosition, setPreferExplicit, setPrompt, setStringDefault, setValue, setValueFromObject, setValueFromString, stringValue, toArray, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

JoinTypeParameter

public JoinTypeParameter(String name)
Method Detail

joinTypeValue

public JoinType joinTypeValue(Environment env)
                       throws TaskException
Returns the value of this parameter as a JoinType.

Returns:
join type
Throws:
TaskException

stringifyOption

public String stringifyOption(JoinType type)
Description copied from class: ChoiceParameter
Determines how an option will be represented as a string value of this parameter if no name has explicitly been supplied. The default implementation is String.valueOf(option), but this may be overrridden.

Overrides:
stringifyOption in class ChoiceParameter<JoinType>
Parameters:
type - option value
Returns:
string representation of option


Copyright © 2015 Central Laboratory of the Research Councils. All Rights Reserved.