|
Java Debug Interface | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Specification for and value of a Connector argument.
Will always implement a subinterface of Argument:
Connector.StringArgument
, Connector.BooleanArgument
,
Connector.IntegerArgument
,
or Connector.SelectedArgument
.
Fields inherited from class java.io.Serializable |
serialVersionUID |
Method Summary | |
java.lang.String |
description()
Returns a human-readable description of this argument and its purpose. |
boolean |
isValid(java.lang.String value)
Performs basic sanity check of argument. |
java.lang.String |
label()
Returns a short human-readable label for this argument. |
boolean |
mustSpecify()
Indicates whether the argument must be specified. |
java.lang.String |
name()
Returns a short, unique identifier for the argument. |
void |
setValue(java.lang.String value)
Sets the value of the argument. |
java.lang.String |
value()
Returns the current value of the argument. |
Method Detail |
public java.lang.String name()
public java.lang.String label()
public java.lang.String description()
public java.lang.String value()
public void setValue(java.lang.String value)
isValid(String)
before setting it; invalid values will throw an exception
when the connection is established - for example,
on LaunchingConnector.launch(java.util.Map)
public boolean isValid(java.lang.String value)
true
if the value is valid to be
used in setValue(String)
public boolean mustSpecify()
setValue(java.lang.String)
must be used to set a non-null value before
using this argument in establishing a connection.true
if the argument must be specified;
false
otherwise.
|
Java Debug Interface | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |