APIdia Launch Partner
Top Inners Fields Constructors Methods
com.sun.tools.jdi

pack-priv abstract Class ConnectorImpl

extends Object
implements Connector
Class Inheritance
All Implemented Interfaces
com.sun.jdi.connect.Connector
Known Direct Subclasses
com.sun.tools.jdi.AbstractLauncher, com.sun.tools.jdi.GenericAttachingConnector, com.sun.tools.jdi.GenericListeningConnector, com.sun.tools.jdi.ProcessAttachingConnector
Imports
java.util.ArrayList, .Collection, .Collections, .Iterator, .LinkedHashMap, .List, .Map, .ResourceBundle, com.sun.jdi.InternalException, com.sun.jdi.connect.Connector, .IllegalConnectorArgumentsException, .LaunchingConnector

Nested and Inner Type Summary

Modifier and TypeClass and Description
pack-priv abstract static class
pack-priv class
pack-priv static class
pack-priv static class
pack-priv static class

Field Summary

Modifier and TypeField and Description
pack-priv Map<String, Connector.Argument>
pack-priv static String
private ResourceBundle
pack-priv static String

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
pack-priv void
addBooleanArgument(String name, String label, String description, boolean defaultValue, boolean mustSpecify)

pack-priv void
addIntegerArgument(String name, String label, String description, String defaultValue, boolean mustSpecify, int min, int max)

pack-priv void
addSelectedArgument(String name, String label, String description, String defaultValue, boolean mustSpecify, List<String> list)

pack-priv void
addStringArgument(String name, String label, String description, String defaultValue, boolean mustSpecify)

pack-priv ConnectorImpl.ArgumentImpl
argument(String name, Map<String, ? extends Connector.Argument> arguments)

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

Implements com.sun.jdi.connect.Connector.defaultArguments.

Returns the arguments accepted by this Connector and their default values.

pack-priv String
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

defaultArgumentsback to summary
pack-priv Map<String, Connector.Argument> defaultArguments
falseStringback to summary
pack-priv static String falseString
messagesback to summary
private ResourceBundle messages
trueStringback to summary
pack-priv static String trueString

Constructor Detail

ConnectorImplback to summary
pack-priv ConnectorImpl()

Method Detail

addBooleanArgumentback to summary
pack-priv void addBooleanArgument(String name, String label, String description, boolean defaultValue, boolean mustSpecify)
addIntegerArgumentback to summary
pack-priv void addIntegerArgument(String name, String label, String description, String defaultValue, boolean mustSpecify, int min, int max)
addSelectedArgumentback to summary
pack-priv void addSelectedArgument(String name, String label, String description, String defaultValue, boolean mustSpecify, List<String> list)
addStringArgumentback to summary
pack-priv void addStringArgument(String name, String label, String description, String defaultValue, boolean mustSpecify)
argumentback to summary
pack-priv ConnectorImpl.ArgumentImpl argument(String name, Map<String, ? extends Connector.Argument> arguments) throws IllegalConnectorArgumentsException
defaultArgumentsback to summary
public Map<String, Connector.Argument> defaultArguments()

Implements com.sun.jdi.connect.Connector.defaultArguments.

Doc from com.sun.jdi.connect.Connector.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.

getStringback to summary
pack-priv String getString(String key)
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

com.sun.tools.jdi back to summary

pack-priv abstract Class ConnectorImpl.ArgumentImpl

extends Object
implements Argument, Cloneable
Class Inheritance
All Implemented Interfaces
java.lang.Cloneable, com.sun.jdi.connect.Connector.Argument, java.io.Serializable
Known Direct Subclasses
com.sun.tools.jdi.ConnectorImpl.BooleanArgumentImpl, com.sun.tools.jdi.ConnectorImpl.IntegerArgumentImpl, com.sun.tools.jdi.ConnectorImpl.StringArgumentImpl, com.sun.tools.jdi.ConnectorImpl.SelectedArgumentImpl
Annotations
@SuppressWarnings:serial

Field Summary

Modifier and TypeField and Description
private String
private String
private boolean
private String
private String

Constructor Summary

AccessConstructor and Description
pack-priv
ArgumentImpl(String name, String label, String description, String value, boolean mustSpecify)

Method Summary

Modifier and TypeMethod and Description
public Object
clone()

Overrides java.lang.Object.clone.

Creates and returns a copy of this object.

public String
description()

Implements com.sun.jdi.connect.Connector.Argument.description.

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

public boolean
equals(Object obj)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public abstract boolean
isValid(String value)

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

Performs basic sanity check of argument.

public String
label()

Implements com.sun.jdi.connect.Connector.Argument.label.

Returns a short human-readable label for this argument.

public boolean
mustSpecify()

Implements com.sun.jdi.connect.Connector.Argument.mustSpecify.

Indicates whether the argument must be specified.

public String
name()

Implements com.sun.jdi.connect.Connector.Argument.name.

Returns a short, unique identifier for the argument.

public void
setValue(String value)

Implements com.sun.jdi.connect.Connector.Argument.setValue.

Sets the value of the argument.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

public String
value()

Implements com.sun.jdi.connect.Connector.Argument.value.

Returns the current value of the argument.

Inherited from java.lang.Object:
finalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

descriptionback to summary
private String description
labelback to summary
private String label
mustSpecifyback to summary
private boolean mustSpecify
nameback to summary
private String name
valueback to summary
private String value

Constructor Detail

ArgumentImplback to summary
pack-priv ArgumentImpl(String name, String label, String description, String value, boolean mustSpecify)

Method Detail

cloneback to summary
public Object clone()

Overrides java.lang.Object.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

x.clone() != x
will be true, and that the expression:
x.clone().getClass() == x.getClass()
will be true, but these are not absolute requirements. While it is typically the case that:
x.clone().equals(x)
will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

descriptionback to summary
public String description()

Implements com.sun.jdi.connect.Connector.Argument.description.

Doc from com.sun.jdi.connect.Connector.Argument.description.

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

equalsback to summary
public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
isValidback to summary
public abstract boolean isValid(String value)

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

Doc from com.sun.jdi.connect.Connector.Argument.isValid.

Performs basic sanity check of argument.

labelback to summary
public String label()

Implements com.sun.jdi.connect.Connector.Argument.label.

Doc from com.sun.jdi.connect.Connector.Argument.label.

Returns a short human-readable label for this argument.

mustSpecifyback to summary
public boolean mustSpecify()

Implements com.sun.jdi.connect.Connector.Argument.mustSpecify.

Doc from com.sun.jdi.connect.Connector.Argument.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.

nameback to summary
public String name()

Implements com.sun.jdi.connect.Connector.Argument.name.

Doc from com.sun.jdi.connect.Connector.Argument.name.

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

setValueback to summary
public void setValue(String value)

Implements com.sun.jdi.connect.Connector.Argument.setValue.

Doc from com.sun.jdi.connect.Connector.Argument.setValue.

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

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

valueback to summary
public String value()

Implements com.sun.jdi.connect.Connector.Argument.value.

Doc from com.sun.jdi.connect.Connector.Argument.value.

Returns the current value of the argument. Initially, the default value is returned. If the value is currently unspecified, null is returned.

com.sun.tools.jdi back to summary

pack-priv Class ConnectorImpl.BooleanArgumentImpl

extends ArgumentImpl
implements BooleanArgument
Class Inheritance
All Implemented Interfaces
com.sun.jdi.connect.Connector.BooleanArgument, com.sun.jdi.connect.Connector.Argument, java.io.Serializable

Field Summary

Modifier and TypeField and Description
private static final long

Constructor Summary

AccessConstructor and Description
pack-priv
BooleanArgumentImpl(String name, String label, String description, boolean value, boolean mustSpecify)

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

the value of the argument as a boolean.
booleanValue
()

Implements com.sun.jdi.connect.Connector.BooleanArgument.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)

Implements abstract com.sun.tools.jdi.ConnectorImpl.ArgumentImpl.isValid.

Implements com.sun.jdi.connect.Connector.BooleanArgument.isValid, com.sun.jdi.connect.Connector.Argument.isValid.

Performs basic sanity check of argument.

public void
setValue(boolean value)

Implements com.sun.jdi.connect.Connector.BooleanArgument.setValue.

Sets the value of the argument.

public String

Returns:

the localized String representation of the boolean value.
stringValueOf
(boolean value)

Implements com.sun.jdi.connect.Connector.BooleanArgument.stringValueOf.

Return the string representation of the value parameter.

Inherited from com.sun.tools.jdi.ConnectorImpl.ArgumentImpl:
clonedescriptionequalshashCodelabelmustSpecifynamesetValuetoStringvalue

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Constructor Detail

BooleanArgumentImplback to summary
pack-priv BooleanArgumentImpl(String name, String label, String description, boolean value, boolean mustSpecify)

Method Detail

booleanValueback to summary
public boolean booleanValue()

Implements com.sun.jdi.connect.Connector.BooleanArgument.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.

isValidback to summary
public boolean isValid(String value)

Implements abstract com.sun.tools.jdi.ConnectorImpl.ArgumentImpl.isValid.

Implements com.sun.jdi.connect.Connector.BooleanArgument.isValid, 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)
setValueback to summary
public void setValue(boolean value)

Implements com.sun.jdi.connect.Connector.BooleanArgument.setValue.

Sets the value of the argument.

stringValueOfback to summary
public String stringValueOf(boolean value)

Implements com.sun.jdi.connect.Connector.BooleanArgument.stringValueOf.

Return the string representation of the value parameter. Does not set or examine the value or the argument.

Returns:String

the localized String representation of the boolean value.

com.sun.tools.jdi back to summary

pack-priv Class ConnectorImpl.IntegerArgumentImpl

extends ArgumentImpl
implements IntegerArgument
Class Inheritance
All Implemented Interfaces
com.sun.jdi.connect.Connector.IntegerArgument, com.sun.jdi.connect.Connector.Argument, java.io.Serializable

Field Summary

Modifier and TypeField and Description
private final int
private final int
private static final long

Constructor Summary

AccessConstructor and Description
pack-priv
IntegerArgumentImpl(String name, String label, String description, String value, boolean mustSpecify, int min, int max)

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

the value of the argument as a int.
intValue
()

Implements com.sun.jdi.connect.Connector.IntegerArgument.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)

Implements abstract com.sun.tools.jdi.ConnectorImpl.ArgumentImpl.isValid.

Implements com.sun.jdi.connect.Connector.IntegerArgument.isValid, com.sun.jdi.connect.Connector.Argument.isValid.

Performs basic sanity check of argument.

public boolean

Returns:

true if min() <= value <= max()
isValid
(int value)

Implements com.sun.jdi.connect.Connector.IntegerArgument.isValid.

Performs basic sanity check of argument.

public int

Returns:

the maximum allowed value for this argument.
max
()

Implements com.sun.jdi.connect.Connector.IntegerArgument.max.

The upper bound for the value.

public int

Returns:

the minimum allowed value for this argument.
min
()

Implements com.sun.jdi.connect.Connector.IntegerArgument.min.

The lower bound for the value.

public void
setValue(int value)

Implements com.sun.jdi.connect.Connector.IntegerArgument.setValue.

Sets the value of the argument.

public String

Returns:

the String representation of the int value.
stringValueOf
(int value)

Implements com.sun.jdi.connect.Connector.IntegerArgument.stringValueOf.

Return the string representation of the value parameter.

Inherited from com.sun.tools.jdi.ConnectorImpl.ArgumentImpl:
clonedescriptionequalshashCodelabelmustSpecifynamesetValuetoStringvalue

Field Detail

maxback to summary
private final int max
minback to summary
private final int min
serialVersionUIDback to summary
private static final long serialVersionUID

Constructor Detail

IntegerArgumentImplback to summary
pack-priv IntegerArgumentImpl(String name, String label, String description, String value, boolean mustSpecify, int min, int max)

Method Detail

intValueback to summary
public int intValue()

Implements com.sun.jdi.connect.Connector.IntegerArgument.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.

isValidback to summary
public boolean isValid(String value)

Implements abstract com.sun.tools.jdi.ConnectorImpl.ArgumentImpl.isValid.

Implements com.sun.jdi.connect.Connector.IntegerArgument.isValid, 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()

isValidback to summary
public boolean isValid(int value)

Implements com.sun.jdi.connect.Connector.IntegerArgument.isValid.

Performs basic sanity check of argument.

Returns:boolean

true if min() <= value <= max()

maxback to summary
public int max()

Implements com.sun.jdi.connect.Connector.IntegerArgument.max.

The upper bound for the value.

Returns:int

the maximum allowed value for this argument.

minback to summary
public int min()

Implements com.sun.jdi.connect.Connector.IntegerArgument.min.

The lower bound for the value.

Returns:int

the minimum allowed value for this argument.

setValueback to summary
public void setValue(int value)

Implements com.sun.jdi.connect.Connector.IntegerArgument.setValue.

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

stringValueOfback to summary
public String stringValueOf(int value)

Implements com.sun.jdi.connect.Connector.IntegerArgument.stringValueOf.

Return the string representation of the value parameter. Does not set or examine the value or the argument.

Returns:String

the String representation of the int value.

com.sun.tools.jdi back to summary

pack-priv Class ConnectorImpl.SelectedArgumentImpl

extends ArgumentImpl
implements SelectedArgument
Class Inheritance
All Implemented Interfaces
com.sun.jdi.connect.Connector.SelectedArgument, com.sun.jdi.connect.Connector.Argument, java.io.Serializable

Field Summary

Modifier and TypeField and Description
private final List<String>
private static final long

Constructor Summary

AccessConstructor and Description
pack-priv
SelectedArgumentImpl(String name, String label, String description, String value, boolean mustSpecify, List<String> choices)

Method Summary

Modifier and TypeMethod and Description
public List<String>

Returns:

List of String
choices
()

Implements com.sun.jdi.connect.Connector.SelectedArgument.choices.

Return the possible values for the argument

public boolean

Returns:

true if value is one of choices().
isValid
(String value)

Implements abstract com.sun.tools.jdi.ConnectorImpl.ArgumentImpl.isValid.

Implements com.sun.jdi.connect.Connector.SelectedArgument.isValid, com.sun.jdi.connect.Connector.Argument.isValid.

Performs basic sanity check of argument.

Inherited from com.sun.tools.jdi.ConnectorImpl.ArgumentImpl:
clonedescriptionequalshashCodelabelmustSpecifynamesetValuetoStringvalue

Field Detail

choicesback to summary
private final List<String> choices
Annotations
@SuppressWarnings:serial
serialVersionUIDback to summary
private static final long serialVersionUID

Constructor Detail

SelectedArgumentImplback to summary
pack-priv SelectedArgumentImpl(String name, String label, String description, String value, boolean mustSpecify, List<String> choices)

Method Detail

choicesback to summary
public List<String> choices()

Implements com.sun.jdi.connect.Connector.SelectedArgument.choices.

Return the possible values for the argument

Returns:List<String>

List of String

isValidback to summary
public boolean isValid(String value)

Implements abstract com.sun.tools.jdi.ConnectorImpl.ArgumentImpl.isValid.

Implements com.sun.jdi.connect.Connector.SelectedArgument.isValid, com.sun.jdi.connect.Connector.Argument.isValid.

Performs basic sanity check of argument.

Returns:boolean

true if value is one of choices().

com.sun.tools.jdi back to summary

pack-priv Class ConnectorImpl.StringArgumentImpl

extends ArgumentImpl
implements StringArgument
Class Inheritance
All Implemented Interfaces
com.sun.jdi.connect.Connector.StringArgument, com.sun.jdi.connect.Connector.Argument, java.io.Serializable

Field Summary

Modifier and TypeField and Description
private static final long

Constructor Summary

AccessConstructor and Description
pack-priv
StringArgumentImpl(String name, String label, String description, String value, boolean mustSpecify)

Method Summary

Modifier and TypeMethod and Description
public boolean
Inherited from com.sun.tools.jdi.ConnectorImpl.ArgumentImpl:
clonedescriptionequalshashCodelabelmustSpecifynamesetValuetoStringvalue

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Constructor Detail

StringArgumentImplback to summary
pack-priv StringArgumentImpl(String name, String label, String description, String value, boolean mustSpecify)

Method Detail

isValidback to summary
public boolean isValid(String value)

Implements abstract com.sun.tools.jdi.ConnectorImpl.ArgumentImpl.isValid.

Implements com.sun.jdi.connect.Connector.StringArgument.isValid, com.sun.jdi.connect.Connector.Argument.isValid.

Performs basic sanity check of argument.

Returns:boolean

true always