- All Superinterfaces:
Serializable
- All Known Subinterfaces:
Connector.BooleanArgument
,Connector.IntegerArgument
,Connector.SelectedArgument
,Connector.StringArgument
- Enclosing interface:
Connector
Specification for and value of a Connector argument.
Will always implement a subinterface of Argument:
Connector.StringArgument
, Connector.BooleanArgument
,
Connector.IntegerArgument
,
or Connector.SelectedArgument
.-
Method Summary
Modifier and TypeMethodDescriptionReturns a human-readable description of this argument and its purpose.boolean
Performs basic sanity check of argument.label()
Returns a short human-readable label for this argument.boolean
Indicates whether the argument must be specified.name()
Returns a short, unique identifier for the argument.void
Sets the value of the argument.value()
Returns the current value of the argument.
-
Method Details
-
name
String name()Returns a short, unique identifier for the argument. Not intended for exposure to end-user.- Returns:
- the name of this argument.
-
label
String label()Returns a short human-readable label for this argument.- Returns:
- a label for this argument
-
description
String description()Returns a human-readable description of this argument and its purpose.- Returns:
- the description of this argument
-
value
String value()Returns the current value of the argument. Initially, the default value is returned. If the value is currently unspecified, null is returned.- Returns:
- the current value of the argument.
-
setValue
Sets the value of the argument. The value should be checked withisValid(String)
before setting it; invalid values will throw an exception when the connection is established - for example, onLaunchingConnector.launch(java.util.Map<java.lang.String, ? extends com.sun.jdi.connect.Connector.Argument>)
-
isValid
Performs basic sanity check of argument.- Returns:
true
if the value is valid to be used insetValue(String)
-
mustSpecify
boolean mustSpecify()Indicates whether the argument must be specified. If true,setValue(java.lang.String)
must be used to set a non-null value before using this argument in establishing a connection.- Returns:
true
if the argument must be specified;false
otherwise.
-