ExtraParameter
public class LayerTypeParameter extends uk.ac.starlink.task.ChoiceParameter<LayerType> implements ExtraParameter
Most of the complication here is generating the auto-documentation. It's not 100% obvious that code belongs here, but I can't think of a better place to put it.
Constructor | Description |
---|---|
LayerTypeParameter(java.lang.String prefix,
java.lang.String suffix,
PlotContext context) |
Constructor.
|
Modifier and Type | Method | Description |
---|---|---|
static uk.ac.starlink.task.Parameter[] |
getCoordParams(Coord[] coords,
java.lang.String suffix,
boolean fullDetail) |
Gets parameters used for specifying coordinate values for a plot.
|
java.lang.String |
getExtraUsage(TableEnvironment env) |
Returns an extended usage message.
|
static uk.ac.starlink.task.Parameter[] |
getInputParams(java.lang.String suffix) |
Gets parameters used for specifying a table with
input data for a plot.
|
static uk.ac.starlink.task.Parameter[] |
getLayerConfigParams(ConfigKey[] configKeys,
java.lang.String suffix,
boolean fullDetail) |
Gets parameters used for speciyfing ConfigKey-based values
for a plot.
|
static LayerType[] |
getLayerTypes(Plotter[] plotters) |
Returns the list of LayerTypes represented by a given list of Plotters.
|
java.lang.String |
stringifyOption(LayerType ltype) |
|
static java.lang.String |
usageWord(uk.ac.starlink.task.Parameter param) |
Returns a "name=<usage>" string for a parameter.
|
static java.util.List<java.lang.String> |
usageWords(uk.ac.starlink.task.Parameter[] params) |
List of name=usage strings for a given set of parameters.
|
addOption, addOption, clearOptions, getName, getOption, getOptionNames, getOptions, getOptionValueList, getUsage, objectToString, setDefaultOption, setUsage, stringToObject
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
clearValue, getDescription, getName, getPosition, getPreferExplicit, getPrompt, getStringDefault, getValueClass, isNullPermitted, objectValue, setDescription, setDescription, setName, setNullPermitted, setPosition, setPreferExplicit, setPrompt, setStringDefault, setValue, setValueFromObject, setValueFromString, stringValue, toArray, toString
public LayerTypeParameter(java.lang.String prefix, java.lang.String suffix, PlotContext context)
prefix
- non-suffix part of this parameter's namesuffix
- layer-specific part of this parameter's namecontext
- plot contextpublic java.lang.String stringifyOption(LayerType ltype)
stringifyOption
in class uk.ac.starlink.task.ChoiceParameter<LayerType>
public java.lang.String getExtraUsage(TableEnvironment env)
ExtraParameter
getExtraUsage
in interface ExtraParameter
env
- execution envrionmentpublic static uk.ac.starlink.task.Parameter[] getInputParams(java.lang.String suffix)
suffix
- layer suffixpublic static uk.ac.starlink.task.Parameter[] getCoordParams(Coord[] coords, java.lang.String suffix, boolean fullDetail)
coords
- coordinates requiredsuffix
- layer suffixfullDetail
- if true, extra detail is appended to the parameter
descriptionspublic static uk.ac.starlink.task.Parameter[] getLayerConfigParams(ConfigKey[] configKeys, java.lang.String suffix, boolean fullDetail)
configKeys
- configuration keyssuffix
- layer suffixfullDetail
- if true, extra detail is appended to the parameter
descriptionspublic static java.util.List<java.lang.String> usageWords(uk.ac.starlink.task.Parameter[] params)
params
- parameter listpublic static java.lang.String usageWord(uk.ac.starlink.task.Parameter param)
param
- parameterCopyright © 2018 Central Laboratory of the Research Councils. All Rights Reserved.