Modifier and Type	Class and Description
public static interface	Connector.Argument Specification for and value of a Connector argument.
public static interface	Connector.BooleanArgument Specification for and value of a Connector argument, whose value is Boolean.
public static interface	Connector.IntegerArgument Specification for and value of a Connector argument, whose value is an integer.
public static interface	Connector.SelectedArgument Specification for and value of a Connector argument, whose value is a String selected from a list of choices.
public static interface	Connector.StringArgument Specification for and value of a Connector argument, whose value is a String.

Modifier and Type	Method and Description
public Map<String, Connector.Argument>	Returns: the map associating argument names with argument information and default value. defaultArguments() Returns the arguments accepted by this Connector and their default values.
public String	Returns: the description of this connector description() Returns a human-readable description of this connector and its purpose.
public String	Returns: the name of this connector. name() Returns a short identifier for the connector.
public Transport	Returns: the `Transport` used by this connector. transport() Returns the transport mechanism used by this connector to establish connections with a target VM.

Method Detail

defaultArguments back to summary

defaultArguments	back to summary
public Map<String, Connector.Argument> defaultArguments() Returns the arguments accepted by this Connector and their default values. The keys of the returned map are string argument names. The values are `Connector.Argument` containing information about the argument and its default value. Returns:Map<String, Connector.Argument> the map associating argument names with argument information and default value.

public Map<String, Connector.Argument> defaultArguments()

Returns the arguments accepted by this Connector and their default values. The keys of the returned map are string argument names. The values are Connector.Argument containing information about the argument and its default value.

Returns:Map<String, Connector.Argument>: the map associating argument names with argument information and default value.

description	back to summary
public String description() Returns a human-readable description of this connector and its purpose. Returns:String the description of this connector

description

back to summary

public String description()

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

Returns:String: the description of this connector

name	back to summary
public String name() Returns a short identifier for the connector. Connector implementors should follow similar naming conventions as are used with packages to avoid name collisions. For example, the Sun connector implementations have names prefixed with "com.sun.jdi.". Not intended for exposure to end-user. Returns:String the name of this connector.

name

back to summary

public String name()

Returns a short identifier for the connector. Connector implementors should follow similar naming conventions as are used with packages to avoid name collisions. For example, the Sun connector implementations have names prefixed with "com.sun.jdi.". Not intended for exposure to end-user.

Returns:String: the name of this connector.

transport back to summary

transport	back to summary
public Transport transport() Returns the transport mechanism used by this connector to establish connections with a target VM. Returns:Transport the `Transport` used by this connector.

public Transport transport()

Returns the transport mechanism used by this connector to establish connections with a target VM.

Returns:Transport: the Transport used by this connector.

com.sun.jdi.connect back to summary

public Interface Connector.Argument

Known Direct Subinterfaces: com.sun.jdi.connect.Connector.BooleanArgument, com.sun.jdi.connect.Connector.IntegerArgument, com.sun.jdi.connect.Connector.StringArgument, com.sun.jdi.connect.Connector.SelectedArgument
Known Direct Implementers: com.sun.tools.jdi.ConnectorImpl.ArgumentImpl

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 Type	Method and Description
public String	Returns: the description of this argument description() Returns a human-readable description of this argument and its purpose.
public boolean	Returns: `true` if the value is valid to be used in `setValue(String)` isValid(String value) Performs basic sanity check of argument.
public String	Returns: a label for this argument label() Returns a short human-readable label for this argument.
public boolean	Returns: `true` if the argument must be specified; `false` otherwise. mustSpecify() Indicates whether the argument must be specified.
public String	Returns: the name of this argument. name() Returns a short, unique identifier for the argument.
public void	setValue(String value) Sets the value of the argument.
public String	Returns: the current value of the argument. value() Returns the current value of the argument.

Method Detail

description	back to summary
public String description() Returns a human-readable description of this argument and its purpose. Returns:String the description of this argument

description

back to summary

public String description()

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

Returns:String: the description of this argument

isValid back to summary

isValid	back to summary
public boolean isValid(String value) Performs basic sanity check of argument. Returns:boolean `true` if the value is valid to be used in `setValue(String)`

public boolean isValid(String value)

Performs basic sanity check of argument.

Returns:boolean: true if the value is valid to be used in setValue(String)

label	back to summary
public String label() Returns a short human-readable label for this argument. Returns:String a label for this argument

label

back to summary

public String label()

Returns a short human-readable label for this argument.

Returns:String: a label for this argument

mustSpecify back to summary

mustSpecify	back to summary
public boolean mustSpecify() Indicates whether the argument must be specified. If true, `setValue` must be used to set a non-null value before using this argument in establishing a connection. Returns:boolean `true` if the argument must be specified; `false` otherwise.

public boolean mustSpecify()

Indicates whether the argument must be specified. If true, setValue must be used to set a non-null value before using this argument in establishing a connection.

Returns:boolean: true if the argument must be specified; false otherwise.

name	back to summary
public String name() Returns a short, unique identifier for the argument. Not intended for exposure to end-user. Returns:String the name of this argument.

name

back to summary

public String name()

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

Returns:String: the name of this argument.

setValue	back to summary
public 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 `LaunchingConnector#launch`

value	back to summary
public 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:String the current value of the argument.

value

back to summary

public 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:String: the current value of the argument.

com.sun.jdi.connect back to summary

public Interface Connector.BooleanArgument

Known Direct Implementers: com.sun.tools.jdi.ConnectorImpl.BooleanArgumentImpl

Specification for and value of a Connector argument, whose value is Boolean. Boolean values are represented by the localized versions of the strings "true" and "false".

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: the value of the argument as a boolean. booleanValue() Return the value of the argument as a boolean.
public boolean	Returns: `true` if value is a string representation of a boolean value. isValid(String value) Redeclares com.sun.jdi.connect.Connector.Argument.isValid. Performs basic sanity check of argument.
public void	setValue(boolean value) Sets the value of the argument.
public String	Returns: the localized String representation of the boolean value. stringValueOf(boolean value) Return the string representation of the `value` parameter.

Inherited from com.sun.jdi.connect.Connector.Argument:: description label mustSpecify name setValue value

Method Detail

booleanValue back to summary

booleanValue	back to summary
public boolean booleanValue() Return the value of the argument as a boolean. Since the argument may not have been set or may have an invalid value `isValid(String)` should be called on `value()` to check its validity. If it is invalid the boolean returned by this method is undefined. Returns:boolean the value of the argument as a boolean.

public boolean booleanValue()

Return the value of the argument as a boolean. Since the argument may not have been set or may have an invalid value isValid(String) should be called on value() to check its validity. If it is invalid the boolean returned by this method is undefined.

Returns:boolean: the value of the argument as a boolean.

isValid back to summary

isValid	back to summary
public boolean isValid(String value) Redeclares com.sun.jdi.connect.Connector.Argument.isValid. Performs basic sanity check of argument. Returns:boolean `true` if value is a string representation of a boolean value. See Also `stringValueOf(boolean)`

public boolean isValid(String value)

Redeclares com.sun.jdi.connect.Connector.Argument.isValid.

Performs basic sanity check of argument.

Returns:boolean: true if value is a string representation of a boolean value.
See Also: stringValueOf(boolean)

setValue	back to summary
public void setValue(boolean value) Sets the value of the argument.

stringValueOf back to summary

stringValueOf	back to summary
public String stringValueOf(boolean value) Return the string representation of the `value` parameter. Does not set or examine the current value of `this` instance. Returns:String the localized String representation of the boolean value.

public String stringValueOf(boolean value)

Return the string representation of the value parameter. Does not set or examine the current value of this instance.

Returns:String: the localized String representation of the boolean value.

com.sun.jdi.connect back to summary

public Interface Connector.IntegerArgument

Known Direct Implementers: com.sun.tools.jdi.ConnectorImpl.IntegerArgumentImpl

Specification for and value of a Connector argument, whose value is an integer. Integer values are represented by their corresponding strings.

Method Summary

Modifier and Type	Method and Description
public int	Returns: the value of the argument as a int. intValue() Return the value of the argument as a int.
public boolean	Returns: `true` if value represents an int that is `min() <= value <= max()` isValid(String value) Redeclares com.sun.jdi.connect.Connector.Argument.isValid. Performs basic sanity check of argument.
public boolean	Returns: `true` if `min() <= value <= max()` isValid(int value) Performs basic sanity check of argument.
public int	Returns: the maximum allowed value for this argument. max() The upper bound for the value.
public int	Returns: the minimum allowed value for this argument. min() The lower bound for the value.
public void	setValue(int value) Sets the value of the argument.
public String	Returns: the String representation of the int value. stringValueOf(int value) Return the string representation of the `value` parameter.

Inherited from com.sun.jdi.connect.Connector.Argument:: description label mustSpecify name setValue value

Method Detail

intValue back to summary

intValue	back to summary
public int intValue() Return the value of the argument as a int. Since the argument may not have been set or may have an invalid value `isValid(String)` should be called on `value()` to check its validity. If it is invalid the int returned by this method is undefined. Returns:int the value of the argument as a int.

public int intValue()

Return the value of the argument as a int. Since the argument may not have been set or may have an invalid value isValid(String) should be called on value() to check its validity. If it is invalid the int returned by this method is undefined.

Returns:int: the value of the argument as a int.

isValid back to summary

isValid	back to summary
public boolean isValid(String value) Redeclares com.sun.jdi.connect.Connector.Argument.isValid. Performs basic sanity check of argument. Returns:boolean `true` if value represents an int that is `min() <= value <= max()`

public boolean isValid(String value)

Redeclares com.sun.jdi.connect.Connector.Argument.isValid.

Performs basic sanity check of argument.

Returns:boolean: true if value represents an int that is min() <= value <= max()

isValid back to summary

isValid	back to summary
public boolean isValid(int value) Performs basic sanity check of argument. Returns:boolean `true` if `min() <= value <= max()`

public boolean isValid(int value)

Performs basic sanity check of argument.

Returns:boolean: true if min() <= value <= max()

max	back to summary
public int max() The upper bound for the value. Returns:int the maximum allowed value for this argument.

max

back to summary

public int max()

The upper bound for the value.

Returns:int: the maximum allowed value for this argument.

min	back to summary
public int min() The lower bound for the value. Returns:int the minimum allowed value for this argument.

min

back to summary

public int min()

The lower bound for the value.

Returns:int: the minimum allowed value for this argument.

setValue	back to summary
public void setValue(int value) Sets the value of the argument. The value should be checked with `isValid(int)` before setting it; invalid values will throw an exception when the connection is established - for example, on `LaunchingConnector#launch`

stringValueOf back to summary

stringValueOf	back to summary
public String stringValueOf(int value) Return the string representation of the `value` parameter. Does not set or examine the current value of `this` instance. Returns:String the String representation of the int value.

public String stringValueOf(int value)

Return the string representation of the value parameter. Does not set or examine the current value of this instance.

Returns:String: the String representation of the int value.

com.sun.jdi.connect back to summary

public Interface Connector.SelectedArgument

Known Direct Implementers: com.sun.tools.jdi.ConnectorImpl.SelectedArgumentImpl

Specification for and value of a Connector argument, whose value is a String selected from a list of choices.

Method Summary

Modifier and Type	Method and Description
public List<String>	Returns: `List` of `String` choices() Return the possible values for the argument
public boolean	Returns: `true` if value is one of `choices()`. isValid(String value) Redeclares com.sun.jdi.connect.Connector.Argument.isValid. Performs basic sanity check of argument.

Inherited from com.sun.jdi.connect.Connector.Argument:: description label mustSpecify name setValue value

Method Detail

choices back to summary

choices	back to summary
public List<String> choices() Return the possible values for the argument Returns:List<String> `List` of `String`

public List<String> choices()

Return the possible values for the argument

Returns:List<String>: List of String

isValid back to summary

isValid	back to summary
public boolean isValid(String value) Redeclares com.sun.jdi.connect.Connector.Argument.isValid. Performs basic sanity check of argument. Returns:boolean `true` if value is one of `choices()`.

public boolean isValid(String value)

Redeclares com.sun.jdi.connect.Connector.Argument.isValid.

Performs basic sanity check of argument.

Returns:boolean: true if value is one of choices().

public Interface Connector

Nested and Inner Type Summary

Method Summary

Method Detail

public Interface Connector.Argument

Method Summary

Method Detail

public Interface Connector.BooleanArgument

Method Summary

Method Detail

public Interface Connector.IntegerArgument

Method Summary

Method Detail

public Interface Connector.SelectedArgument

Method Summary

Method Detail

public Interface Connector.StringArgument

Method Summary

Method Detail