|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.ttools.cea.CeaParameter
public class CeaParameter
Represents a parameter of a CEA task.
Constructor Summary | |
---|---|
CeaParameter(uk.ac.starlink.task.Parameter taskParam)
Constructor. |
Method Summary | |
---|---|
String |
getDefault()
Returns the default value of this parameter if there is one. |
String |
getDescription()
Returns this parameter's description. |
String |
getName()
Returns this parameter's name. |
String[] |
getOptions()
Returns an array of permitted options if there is one. |
String |
getSummary()
Returns a one-line summary of this parameter's purpose. |
String |
getType()
Returns the CEA type (CmdLineParameterDef/type) of this parameter. |
boolean |
isMulti()
Returns whether this parameter can be specified multiple times on the command line. |
boolean |
isNullPermitted()
Returns whether null is a permitted value for this parameter. |
boolean |
isOutput()
Returns whether this parameter is an output parameter in the CEA sense. |
boolean |
isRef()
Returns whether this parameter is a CEA 'reference' parameter (points to a file). |
void |
setOutput(boolean isOutput)
|
void |
setRef(boolean isRef)
|
void |
truncateDescription()
Truncates this parameter's description to its first sentence. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public CeaParameter(uk.ac.starlink.task.Parameter taskParam)
taskParam
- parameter within the ttools/task parameter systemMethod Detail |
---|
public String getName()
public String getDescription()
public String getSummary()
public String getType()
public boolean isOutput()
public void setOutput(boolean isOutput)
public void setRef(boolean isRef)
public boolean isRef()
public boolean isMulti()
public boolean isNullPermitted()
public String getDefault()
public String[] getOptions()
public void truncateDescription()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |