Skip to main content
summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMarkus Tiede2014-10-17 08:17:53 +0000
committerMarkus Tiede2014-10-17 08:17:53 +0000
commite600bf8a59e37d5ad54f20eab9c31dbb428ec319 (patch)
tree5eec3998c26959f78985c300536f6e7a69cfea71 /org.eclipse.jubula.client.api
parent3fed324f41468f47a3b995be04e781ed9c8e4870 (diff)
downloadorg.eclipse.jubula.core-e600bf8a59e37d5ad54f20eab9c31dbb428ec319.tar.gz
org.eclipse.jubula.core-e600bf8a59e37d5ad54f20eab9c31dbb428ec319.tar.xz
org.eclipse.jubula.core-e600bf8a59e37d5ad54f20eab9c31dbb428ec319.zip
Non-sprint task - enhanced interface descriptions.
Diffstat (limited to 'org.eclipse.jubula.client.api')
-rw-r--r--org.eclipse.jubula.client.api/src/org/eclipse/jubula/client/AUT.java6
-rw-r--r--org.eclipse.jubula.client.api/src/org/eclipse/jubula/client/AUTAgent.java8
-rw-r--r--org.eclipse.jubula.client.api/src/org/eclipse/jubula/client/MakeR.java12
-rw-r--r--org.eclipse.jubula.client.api/src/org/eclipse/jubula/client/ObjectMapping.java6
-rw-r--r--org.eclipse.jubula.client.api/src/org/eclipse/jubula/client/Remote.java6
-rw-r--r--org.eclipse.jubula.client.api/src/org/eclipse/jubula/client/Result.java4
-rw-r--r--org.eclipse.jubula.client.api/src/org/eclipse/jubula/client/launch/AUTConfiguration.java6
7 files changed, 37 insertions, 11 deletions
diff --git a/org.eclipse.jubula.client.api/src/org/eclipse/jubula/client/AUT.java b/org.eclipse.jubula.client.api/src/org/eclipse/jubula/client/AUT.java
index f6f118db3..19cd2ec77 100644
--- a/org.eclipse.jubula.client.api/src/org/eclipse/jubula/client/AUT.java
+++ b/org.eclipse.jubula.client.api/src/org/eclipse/jubula/client/AUT.java
@@ -16,10 +16,12 @@ import org.eclipse.jubula.tools.AUTIdentifier;
/**
* @author BREDEX GmbH
+ * @noextend This interface is not intended to be extended by clients.
+ * @noimplement This interface is not intended to be implemented by clients.
*/
public interface AUT extends Remote {
/**
- * @return the identifier of this AUT
+ * @return the AUTIdentifier of this AUT
*/
AUTIdentifier getIdentifier();
@@ -35,7 +37,7 @@ public interface AUT extends Remote {
* in case of remote execution problems
*/
<T> Result<T> execute(CAP cap, T payload) throws ExecutionException;
-
+
/**
* @param cap
* the CAP to execute on the AUT
diff --git a/org.eclipse.jubula.client.api/src/org/eclipse/jubula/client/AUTAgent.java b/org.eclipse.jubula.client.api/src/org/eclipse/jubula/client/AUTAgent.java
index b0173758d..1843bb7dd 100644
--- a/org.eclipse.jubula.client.api/src/org/eclipse/jubula/client/AUTAgent.java
+++ b/org.eclipse.jubula.client.api/src/org/eclipse/jubula/client/AUTAgent.java
@@ -16,14 +16,18 @@ import org.eclipse.jubula.client.launch.AUTConfiguration;
import org.eclipse.jubula.toolkit.ToolkitInfo;
import org.eclipse.jubula.tools.AUTIdentifier;
-/** @author BREDEX GmbH */
+/**
+ * @author BREDEX GmbH
+ * @noextend This interface is not intended to be extended by clients.
+ * @noimplement This interface is not intended to be implemented by clients.
+ */
public interface AUTAgent extends Remote {
/**
* start an AUT
*
* @param configuration
* an AUT configuration to launch the AUT
- * @return a reference to the running AUT
+ * @return an identifier for the running AUT
*/
AUTIdentifier startAUT(AUTConfiguration configuration) throws Exception;
diff --git a/org.eclipse.jubula.client.api/src/org/eclipse/jubula/client/MakeR.java b/org.eclipse.jubula.client.api/src/org/eclipse/jubula/client/MakeR.java
index 874ac00b7..9ee5b5d97 100644
--- a/org.eclipse.jubula.client.api/src/org/eclipse/jubula/client/MakeR.java
+++ b/org.eclipse.jubula.client.api/src/org/eclipse/jubula/client/MakeR.java
@@ -15,7 +15,11 @@ import java.io.InputStream;
import org.eclipse.jubula.client.internal.impl.AUTAgentImpl;
import org.eclipse.jubula.client.internal.impl.ObjectMappingImpl;
-/** @author BREDEX GmbH */
+/**
+ * @author BREDEX GmbH
+ * @noextend This interface is not intended to be extended by clients.
+ * @noimplement This interface is not intended to be implemented by clients.
+ */
public final class MakeR {
/** Constructor */
private MakeR() {
@@ -32,10 +36,12 @@ public final class MakeR {
public static AUTAgent createAUTAgent(final String hostname, int port) {
return new AUTAgentImpl(hostname, port);
}
-
+
/**
* @return a new Object Mapping instance
- * @param input the input stream containing the encoded object mapping
+ * @param input
+ * an input stream providing the exported object mapping
+ * properties
*/
public static ObjectMapping createObjectMapping(InputStream input) {
return new ObjectMappingImpl(input);
diff --git a/org.eclipse.jubula.client.api/src/org/eclipse/jubula/client/ObjectMapping.java b/org.eclipse.jubula.client.api/src/org/eclipse/jubula/client/ObjectMapping.java
index 479cbb294..c19fb3fc2 100644
--- a/org.eclipse.jubula.client.api/src/org/eclipse/jubula/client/ObjectMapping.java
+++ b/org.eclipse.jubula.client.api/src/org/eclipse/jubula/client/ObjectMapping.java
@@ -13,15 +13,17 @@ package org.eclipse.jubula.client;
import org.eclipse.jubula.tools.ComponentIdentifier;
/**
- * Utility class for loading object mapping associations
+ * Class for retrieving component identifier
*
* @author BREDEX GmbH
* @created Oct 13, 2014
+ * @noextend This interface is not intended to be extended by clients.
+ * @noimplement This interface is not intended to be implemented by clients.
*/
public interface ObjectMapping {
/**
- * Returns the component identifier for a component name from the cache
+ * Returns a component identifier for the given component name
*
* @param compName
* the component name
diff --git a/org.eclipse.jubula.client.api/src/org/eclipse/jubula/client/Remote.java b/org.eclipse.jubula.client.api/src/org/eclipse/jubula/client/Remote.java
index a655daede..1ff6fe240 100644
--- a/org.eclipse.jubula.client.api/src/org/eclipse/jubula/client/Remote.java
+++ b/org.eclipse.jubula.client.api/src/org/eclipse/jubula/client/Remote.java
@@ -10,7 +10,11 @@
*******************************************************************************/
package org.eclipse.jubula.client;
-/** @author BREDEX GmbH */
+/**
+ * @author BREDEX GmbH
+ * @noextend This interface is not intended to be extended by clients.
+ * @noimplement This interface is not intended to be implemented by clients.
+ */
public interface Remote {
/**
* connect to the remote side
diff --git a/org.eclipse.jubula.client.api/src/org/eclipse/jubula/client/Result.java b/org.eclipse.jubula.client.api/src/org/eclipse/jubula/client/Result.java
index 5d37d9a69..f659cae5a 100644
--- a/org.eclipse.jubula.client.api/src/org/eclipse/jubula/client/Result.java
+++ b/org.eclipse.jubula.client.api/src/org/eclipse/jubula/client/Result.java
@@ -13,9 +13,13 @@ package org.eclipse.jubula.client;
import org.eclipse.jubula.communication.CAP;
/**
+ * Representing the result of a remotely executed CAP
+ *
* @author BREDEX GmbH
* @param <T>
* the payload type
+ * @noextend This interface is not intended to be extended by clients.
+ * @noimplement This interface is not intended to be implemented by clients.
*/
public interface Result<T> {
/**
diff --git a/org.eclipse.jubula.client.api/src/org/eclipse/jubula/client/launch/AUTConfiguration.java b/org.eclipse.jubula.client.api/src/org/eclipse/jubula/client/launch/AUTConfiguration.java
index 37448b082..de5064d56 100644
--- a/org.eclipse.jubula.client.api/src/org/eclipse/jubula/client/launch/AUTConfiguration.java
+++ b/org.eclipse.jubula.client.api/src/org/eclipse/jubula/client/launch/AUTConfiguration.java
@@ -12,7 +12,11 @@ package org.eclipse.jubula.client.launch;
import java.util.Map;
-/** @author BREDEX GmbH */
+/**
+ * @author BREDEX GmbH
+ * @noextend This interface is not intended to be extended by clients.
+ * @noimplement This interface is not intended to be implemented by clients.
+ */
public interface AUTConfiguration {
/**
* @return a map of launch information

Back to the top