public class ALDOpParameterDescriptor extends ALDParameterDescriptor implements Cloneable
A ALDOpParameterDescriptor has a direction (IN, OUT, INOUT) and
a boolean indicating if this parameter is supplemental.
| Modifier and Type | Field and Description |
|---|---|
protected Parameter.Direction |
direction |
protected Boolean |
supplemental |
dataIOOrder, defaultValue, explanation, field, handlingMode, label, myclass, name, required| Constructor and Description |
|---|
ALDOpParameterDescriptor(String name,
Parameter.Direction direction,
Boolean supplemental,
Class<?> cl,
String explanation,
String label,
boolean required,
Object defaultValue,
Field field,
int guiOrder,
Parameter.ExpertMode mode)
Construct a descriptor
|
| Modifier and Type | Method and Description |
|---|---|
ALDOpParameterDescriptor |
clone()
Clone an instance
|
ALDOpParameterDescriptor |
copy(Field field) |
Parameter.Direction |
getDirection()
Returns parameter direction.
|
Boolean |
getSupplemental()
Returns if parameter is supplemental.
|
void |
print(PrintStream outfile)
Print this descriptor to outfile
|
void |
print(PrintStream outfile,
ALDOperator op)
Print this descriptor to outfile.
|
getDataIOOrder, getDefaultValue, getExplanation, getField, getHandlingMode, getLabel, getMyclass, getName, isRequired, print, setDefaultValueprotected final Parameter.Direction direction
protected final Boolean supplemental
public ALDOpParameterDescriptor(String name, Parameter.Direction direction, Boolean supplemental, Class<?> cl, String explanation, String label, boolean required, Object defaultValue, Field field, int guiOrder, Parameter.ExpertMode mode)
name - Name of parameter.direction - Direction of parameter: IN/OUT/INOUT.supplemental - Supplemental parameter flag.cl - Java class.explanation - Explanatory string.label - Label for parameter.required - Is this argument required for the operator?defaultValue - Default value.field - The field for this member.guiOrder - Position in GUI of this member.mode - Mode for handling the parameter.public ALDOpParameterDescriptor copy(Field field)
public ALDOpParameterDescriptor clone()
clone in class ALDParameterDescriptorpublic void print(PrintStream outfile)
print in class ALDParameterDescriptorpublic void print(PrintStream outfile, ALDOperator op)
If op is non null then try to get the value of the parameter and print it also.
public Parameter.Direction getDirection()
public Boolean getSupplemental()
Copyright © 2010–2015 Martin Luther University Halle-Wittenberg. All rights reserved.