public static interface

Connector.Argument

implements Serializable
com.sun.jdi.connect.Connector.Argument
Known Indirect Subclasses

Class Overview

Specification for and value of a Connector argument. Will always implement a subinterface of Argument: Connector.StringArgument, Connector.BooleanArgument, Connector.IntegerArgument, or Connector.SelectedArgument.

Summary

Public Methods
abstract String description()
Returns a human-readable description of this argument and its purpose.
abstract boolean isValid(String value)
Performs basic sanity check of argument.
abstract String label()
Returns a short human-readable label for this argument.
abstract boolean mustSpecify()
Indicates whether the argument must be specified.
abstract String name()
Returns a short, unique identifier for the argument.
abstract void setValue(String value)
Sets the value of the argument.
abstract String value()
Returns the current value of the argument.

Public Methods

public abstract String description ()

Returns a human-readable description of this argument and its purpose.

Returns
  • the description of this argument

public abstract boolean isValid (String value)

Performs basic sanity check of argument.

Returns

public abstract String label ()

Returns a short human-readable label for this argument.

Returns
  • a label for this argument

public abstract boolean mustSpecify ()

Indicates whether the argument must be specified. If true, setValue(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.

public abstract String name ()

Returns a short, unique identifier for the argument. Not intended for exposure to end-user.

Returns
  • the name of this argument.

public abstract void setValue (String value)

Sets the value of the argument. The value should be checked with isValid(String) before setting it; invalid values will throw an exception when the connection is established - for example, on launch(Map)

public abstract 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.