< prev index next >
src/jdk.jdi/share/classes/com/sun/jdi/connect/Connector.java
Print this page
rev 17275 : 8181417: Code cleanups in com.sun.jdi
@@ -1,7 +1,7 @@
/*
- * Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1998, 2017, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
@@ -23,13 +23,13 @@
* questions.
*/
package com.sun.jdi.connect;
-import java.util.Map;
-import java.util.List;
import java.io.Serializable;
+import java.util.List;
+import java.util.Map;
/**
* A method of connection between a debugger and a target VM.
* A connector encapsulates exactly one {@link Transport}. used
* to establish the connection. Each connector has a set of arguments
@@ -44,10 +44,11 @@
*
* @author Gordon Hirsch
* @since 1.3
*/
public interface Connector {
+
/**
* 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.".
@@ -80,20 +81,21 @@
* information about the argument and its default value.
*
* @return the map associating argument names with argument
* information and default value.
*/
- Map<String,Connector.Argument> defaultArguments();
+ Map<String, Connector.Argument> defaultArguments();
/**
* Specification for and value of a Connector argument.
* Will always implement a subinterface of Argument:
* {@link Connector.StringArgument}, {@link Connector.BooleanArgument},
* {@link Connector.IntegerArgument},
* or {@link Connector.SelectedArgument}.
*/
public interface Argument extends Serializable {
+
/**
* Returns a short, unique identifier for the argument.
* Not intended for exposure to end-user.
*
* @return the name of this argument.
@@ -155,10 +157,11 @@
* 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".
*/
public interface BooleanArgument extends Argument {
+
/**
* Sets the value of the argument.
*/
void setValue(boolean value);
@@ -195,10 +198,11 @@
* Specification for and value of a Connector argument,
* whose value is an integer. Integer values are represented
* by their corresponding strings.
*/
public interface IntegerArgument extends Argument {
+
/**
* Sets the value of the argument.
* The value should be checked with {@link #isValid(int)}
* before setting it; invalid values will throw an exception
* when the connection is established - for example,
< prev index next >