ASSIGN.
- * issueCommand(ICicsTerminal, "ASSIGN USERID(&VAR)", false)
- * retrieveVariableText(ICicsTerminal, "ASSIGN USERID(&VAR)", false)
+ * issueCommand(ICicsTerminal, "ASSIGN USERID(&VAR)", false)
+ * retrieveVariableText(ICicsTerminal, "ASSIGN USERID(&VAR)", false)
*
* @return an {@link ICeciResponse} object containing the command's response.
* @throws CeciException
@@ -239,7 +239,7 @@ public interface ICeci {
/**
* Retrieve the content of the current EXEC Interface Block (EIB)
- * @param terminal an {@link ICicsTerminal} object logged on to the CICS region and in an active CECI session.
+ * @param ceciTerminal an {@link ICicsTerminal} object logged on to the CICS region and in an active CECI session.
* @return the {@link IExecInterfaceBlock}
* @throws CeciException
*/
@@ -252,7 +252,7 @@ public interface ICeci {
* For example, the test could first issue CEOT TRANIDONLY
* @param programName the name of the PROGRAM
* @param commarea a string representing the COMMAREA. If null, COMMAREA will be omitted from the command. Can be CECI variable name populated with
- * (&name set via {@link #defineVariableText(ICicsTerminal, String, String)}) or the actual data. The value of DATALENGTH in the command will be
+ * (&)name set via {@link #defineVariableText(ICicsTerminal, String, String)}) or the actual data. The value of DATALENGTH in the command will be
* be allowed to default.
* @param sysid the system name where the CICS region where the link request is to be routed. If null, SYSID will be omitted from the command.
* @param transid the name of the mirror transaction on the remote region. If null, TRANSID will be omitted from the command.
@@ -263,8 +263,8 @@ public interface ICeci {
public ICeciResponse linkProgram(@NotNull ICicsTerminal ceciTerminal, @NotNull String programName, String commarea, String sysid, String transid, boolean synconreturn) throws CeciException;
/**
- * EXEC CICS LINK to a PROGRAM with a CHANNEL. Use {@link #putContainer(ICicsTerminal, String, String, String)} to create the container(s) on the CHANNEL
- * and {@link #getContainer(ICicsTerminal, String, String, String)} to retrieve the content after the LINK.
+ * EXEC CICS LINK to a PROGRAM with a CHANNEL. Use {@link #putContainer(ICicsTerminal, String, String, String, String, String, String)} to create the container(s) on the CHANNEL
+ * and {@link #getContainer(ICicsTerminal, String, String, String, String, String)} to retrieve the content after the LINK.
* @param ceciTerminal an {@link ICicsTerminal} object logged on to the CICS region and in an active CECI session.
* If mixed case is required, the terminal should be presented with no upper case translate status.
* For example, the test could first issue CEOT TRANIDONLY
@@ -279,7 +279,7 @@ public interface ICeci {
* @param ceciTerminal an {@link ICicsTerminal} object logged on to the CICS region and in an active CECI session.
* @param channelName the CHANNELNAME
* @param containerName the COTAINER name
- * @param content a string representing the container contents. Can be CECI variable name populated with (&name set via {@link #defineVariableText(ICicsTerminal, String, String)})
+ * @param content a string representing the container contents. Can be CECI variable name populated with (&)name set via {@link #defineVariableText(ICicsTerminal, String, String)})
* or the actual data. The value of FLENGTH in the command will be set to the data length.
* @param dataType BIT or CHAR. If null, DATATYPE will be omitted from the command.
* @param fromCcsid provides a value for FROMCCSID. If null, will be omitted from the command.
@@ -296,8 +296,7 @@ public interface ICeci {
* For example, the test could first issue CEOT TRANIDONLY
* @param channelName the CHANNELNAME
* @param containerName the CONTAINER name
- * @param variableName the CECI variable name. Data can be retrieved using {@link #retrieveVariableText(ICicsTerminal, String)} or {@link #retrieveVariableHex(ICicsTerminal, String)}
- * @param dataType BIT or CHAR. If null, DATATYPE will be omitted from the command.
+ * @param variableName the CECI variable name. Data can be retrieved using {@link #retrieveVariableText(ICicsTerminal, String)}
* @param intoCcsid provides a value for INTOCCSID. If null, will be omitted from the command.
* @param intoCodepage provides a value for INTOCODEPAGE. If null, will be omitted from the command.
* @return an {@link ICeciResponse} object containing the command's response.
diff --git a/galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.manager/src/main/java/dev/galasa/cicsts/ICemt.java b/galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.manager/src/main/java/dev/galasa/cicsts/ICemt.java
index 2cb9990a8..2dbf3646d 100644
--- a/galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.manager/src/main/java/dev/galasa/cicsts/ICemt.java
+++ b/galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.manager/src/main/java/dev/galasa/cicsts/ICemt.java
@@ -16,7 +16,7 @@ public interface ICemt {
/**
* Inquire a CEMT resource using the resource type and name.
* This does not support inquiries of multiple resources at once.
- * Will return {@link null} if the resource is not found.
+ * @return null if the resource is not found.
* @param cemtTerminal an {@link ITerminal} object logged on to the CICS region and in an active CEMT session.
* If mixed case is required, the terminal should be presented with no upper case translate status.
* For example, the test could first issue CEOT TRANIDONLY
diff --git a/galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.manager/src/main/java/dev/galasa/cicsts/IExecInterfaceBlock.java b/galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.manager/src/main/java/dev/galasa/cicsts/IExecInterfaceBlock.java
index 9102e2ee6..6be5e8910 100644
--- a/galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.manager/src/main/java/dev/galasa/cicsts/IExecInterfaceBlock.java
+++ b/galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.manager/src/main/java/dev/galasa/cicsts/IExecInterfaceBlock.java
@@ -1,8 +1,8 @@
-/*
- * Copyright contributors to the Galasa project
- *
- * SPDX-License-Identifier: EPL-2.0
- */
+/*
+ * Copyright contributors to the Galasa project
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
package dev.galasa.cicsts;
/**
@@ -12,188 +12,186 @@
public interface IExecInterfaceBlock {
/**
- * Returns a {@link String} representation of the EIBRESP field if available
- * @return
+ * @return a {@link String} representation of the EIBRESP field if available
*/
public String getResponse();
/**
- * Returns the value of the EIBTIME field in the EIB.
- * @return
+ * @return the value of the EIBTIME field in the EIB.
+ *
*/
public int getEIBTIME();
/**
- * Returns the value of the EIBDATE field in the EIB.
- * @return
+ * @return the value of the EIBDATE field in the EIB.
+ *
*/
public int getEIBDATE();
/**
- * Returns the value of the EIBTRNID field in the EIB.
+ * @return the value of the EIBTRNID field in the EIB.
* @param hex return a char array containing the hex values of the field
- * @return
+ *
*/
public String getEIBTRNID(boolean hex);
/**
- * Returns the value of the EIBTASKN field in the EIB.
- * @return
+ * @return the value of the EIBTASKN field in the EIB.
+ *
*/
public int getEIBTASKN();
/**
- * Returns the value of the EIBTRMID field in the EIB.
+ * @return the value of the EIBTRMID field in the EIB.
* @param hex return a char array containing the hex values of the field
- * @return
+ *
*/
public String getEIBTRMID(boolean hex);
/**
- * Returns the value of the EIBCPOSN field in the EIB.
- * @param hex return a char array containing the hex values of the field
- * @return
+ * @return the value of the EIBCPOSN field in the EIB.
+ *
*/
public int getEIBCPOSN();
/**
- * Returns the value of the EIBCALEN field in the EIB.
- * @return
+ * @return the value of the EIBCALEN field in the EIB.
+ *
*/
public int getEIBCALEN();
/**
- * Returns the value of the EIBAID field in the EIB.
- * @return
+ * @return the value of the EIBAID field in the EIB.
+ *
*/
public char getEIBAID();
/**
- * Returns the value of the EIBFN field in the EIB.
- * @return
+ * @return the value of the EIBFN field in the EIB.
+ *
*/
public char[] getEIBFN();
/**
- * Returns the value of the EIBRCODE field in the EIB.
- * @return
+ * @return the value of the EIBRCODE field in the EIB.
+ *
*/
public char[] getEIBRCODE();
/**
- * Returns the value of the EIBDS field in the EIB.
+ * @return the value of the EIBDS field in the EIB.
* @param hex return a char array containing the hex values of the field
- * @return
+ *
*/
public String getEIBDS(boolean hex);
/**
- * Returns the value of the EIBREQID field in the EIB.
+ * @return the value of the EIBREQID field in the EIB.
* @param hex return a char array containing the hex values of the field
- * @return
+ *
*/
public String getEIBREQID(boolean hex);
/**
- * Returns the value of the EIBRSRCE field in the EIB.
+ * @return the value of the EIBRSRCE field in the EIB.
* @param hex return a char array containing the hex values of the field
- * @return
+ *
*/
public String getEIBRSRCE(boolean hex);
/**
- * Returns the value of the EIBSYNC field in the EIB.
- * @return
+ * @return the value of the EIBSYNC field in the EIB.
+ *
*/
public char getEIBSYNC();
/**
- * Returns the value of the EIBFREE field in the EIB.
- * @return
+ * @return the value of the EIBFREE field in the EIB.
+ *
*/
public char getEIBFREE();
/**
- * Returns the value of the EIBRECV field in the EIB.
- * @return
+ * @return the value of the EIBRECV field in the EIB.
+ *
*/
public char getEIBRECV();
/**
- * Returns the value of the EIBATT field in the EIB.
- * @return
+ * @return the value of the EIBATT field in the EIB.
+ *
*/
public char getEIBATT();
/**
- * Returns the value of the EIBEOC field in the EIB.
- * @return
+ * @return the value of the EIBEOC field in the EIB.
+ *
*/
public char getEIBEOC();
/**
- * Returns the value of the field in the EIB.
- * @return
+ * @return the value of the field in the EIB.
+ *
*/
public char getEIBFMH();
/**
- * Returns the value of the EIBCOMPL field in the EIB.
- * @return
+ * @return the value of the EIBCOMPL field in the EIB.
+ *
*/
public char getEIBCOMPL();
/**
- * Returns the value of the EIBSIG field in the EIB.
- * @return
+ * @return the value of the EIBSIG field in the EIB.
+ *
*/
public char getEIBSIG();
/**
- * Returns the value of the EIBCONF field in the EIB.
- * @return
+ * @return the value of the EIBCONF field in the EIB.
+ *
*/
public char getEIBCONF();
/**
- * Returns the value of the EIBERR field in the EIB.
- * @return
+ * @return the value of the EIBERR field in the EIB.
+ *
*/
public char getEIBERR();
/**
- * Returns the value of the EIBERRCD field in the EIB.
- * @return
+ * @return the value of the EIBERRCD field in the EIB.
+ *
*/
public char[] getEIBERRCD();
/**
- * Returns the value of the EIBSYNRB field in the EIB.
- * @return
+ * @return the value of the EIBSYNRB field in the EIB.
+ *
*/
public char getEIBSYNRB();
/**
- * Returns the value of the EIBNODAT field in the EIB.
- * @return
+ * @return the value of the EIBNODAT field in the EIB.
+ *
*/
public char getEIBNODAT();
/**
- * Returns the value of the EIBRESP field in the EIB.
- * @return
+ * @return the value of the EIBRESP field in the EIB.
+ *
*/
public int getEIBRESP();
/**
- * Returns the value of the EIBRESP2 field in the EIB.
- * @return
+ * @return the value of the EIBRESP2 field in the EIB.
+ *
*/
public int getEIBRESP2();
/**
- * Returns the value of the EIBRLDBK field in the EIB.
- * @return
+ * @return the value of the EIBRLDBK field in the EIB.
+ *
*/
public char getEIBRLDBK();
}
diff --git a/galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.manager/src/main/java/dev/galasa/cicsts/cicsresource/IJvmserver.java b/galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.manager/src/main/java/dev/galasa/cicsts/cicsresource/IJvmserver.java
index b324a94b9..974c5b35b 100644
--- a/galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.manager/src/main/java/dev/galasa/cicsts/cicsresource/IJvmserver.java
+++ b/galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.manager/src/main/java/dev/galasa/cicsts/cicsresource/IJvmserver.java
@@ -1,8 +1,8 @@
-/*
- * Copyright contributors to the Galasa project
- *
- * SPDX-License-Identifier: EPL-2.0
- */
+/*
+ * Copyright contributors to the Galasa project
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
package dev.galasa.cicsts.cicsresource;
import java.util.List;
@@ -394,7 +394,6 @@ public enum PurgeType {
/**
* Delete the JVM server logs
- * @param rasPath path in Results Archive Store
* @throws CicsJvmserverResourceException
*/
public void clearJvmLogs() throws CicsJvmserverResourceException;
diff --git a/galasa-managers-parent/galasa-managers-cloud-parent/dev.galasa.cloud.manager/src/main/java/dev/galasa/cloud/internal/CloudManagerImpl.java b/galasa-managers-parent/galasa-managers-cloud-parent/dev.galasa.cloud.manager/src/main/java/dev/galasa/cloud/internal/CloudManagerImpl.java
index 9ee52b4f0..5b86405ae 100644
--- a/galasa-managers-parent/galasa-managers-cloud-parent/dev.galasa.cloud.manager/src/main/java/dev/galasa/cloud/internal/CloudManagerImpl.java
+++ b/galasa-managers-parent/galasa-managers-cloud-parent/dev.galasa.cloud.manager/src/main/java/dev/galasa/cloud/internal/CloudManagerImpl.java
@@ -168,7 +168,7 @@ public void provisionGenerate() throws ManagerException, ResourceUnavailableExce
*
* @param field The test field
* @param annotations any annotations with the ecosystem
- * @return a {@link IKubernetesEcosystem} ecosystem
+ * @return a {@link dev.galasa.galasaecosystem.IKubernetesEcosystem} ecosystem
* @throws InsufficientResourcesAvailableException
* @throws KubernetesManagerException if there is a problem generating a ecosystem
*/
diff --git a/galasa-managers-parent/galasa-managers-cloud-parent/dev.galasa.docker.manager/src/main/java/dev/galasa/docker/internal/DockerContainerImpl.java b/galasa-managers-parent/galasa-managers-cloud-parent/dev.galasa.docker.manager/src/main/java/dev/galasa/docker/internal/DockerContainerImpl.java
index bd5571d88..44b29aa58 100644
--- a/galasa-managers-parent/galasa-managers-cloud-parent/dev.galasa.docker.manager/src/main/java/dev/galasa/docker/internal/DockerContainerImpl.java
+++ b/galasa-managers-parent/galasa-managers-cloud-parent/dev.galasa.docker.manager/src/main/java/dev/galasa/docker/internal/DockerContainerImpl.java
@@ -417,7 +417,7 @@ public Mapcom.google.gson.JsonObject and receiving a com.google.gson.JsonObject in the response.
*
* @param url
* @param json
- * @return - {@link HttpClientResponse} with a {@link JSONObject} content type
+ * @return - {@link HttpClientResponse} with a com.google.gson.JsonObject content type
* @throws HttpClientException
*/
HttpClientResponse- * Will only populate public {@link java.lang.Stringdev.galasa.core.manager.IResourceString} fields. + * Will only populate public {@link dev.galasa.core.manager.IResourceString} fields. *
* * @author Michael Baylis @@ -37,7 +37,7 @@ * * The tag must be provided as there is no default for this resource. * - * The {@link java.lang.Stringdev.galasa.core.manager.IResourceString} object is keyed on the tag, so if the tag is referred to in multiple + * The {@link dev.galasa.core.manager.IResourceString} object is keyed on the tag, so if the tag is referred to in multiple * super classes, then the lengths must be identical otherwise an exception will be thrown. */ String tag(); diff --git a/galasa-managers-parent/galasa-managers-core-parent/dev.galasa.core.manager/src/main/java/dev/galasa/core/manager/StoredArtifactRoot.java b/galasa-managers-parent/galasa-managers-core-parent/dev.galasa.core.manager/src/main/java/dev/galasa/core/manager/StoredArtifactRoot.java index 90d7294b3..81b656792 100644 --- a/galasa-managers-parent/galasa-managers-core-parent/dev.galasa.core.manager/src/main/java/dev/galasa/core/manager/StoredArtifactRoot.java +++ b/galasa-managers-parent/galasa-managers-core-parent/dev.galasa.core.manager/src/main/java/dev/galasa/core/manager/StoredArtifactRoot.java @@ -18,9 +18,9 @@ * Fill this field Root path of the Stored Artifacts for this Test Run. This can * be used to record test logs, job output, trace files etc. * - * Will only populate public {@link java.nio.files.Path} fields. + * Will only populate public {@link java.nio.file.Path} fields. * - * @see java.nio.files.Path + * @see java.nio.file.Path */ @Retention(RUNTIME) @Target(FIELD) diff --git a/galasa-managers-parent/galasa-managers-core-parent/dev.galasa.textscan.manager/src/main/java/dev/galasa/textscan/ILogScanner.java b/galasa-managers-parent/galasa-managers-core-parent/dev.galasa.textscan.manager/src/main/java/dev/galasa/textscan/ILogScanner.java index 981632a97..32e94d4eb 100644 --- a/galasa-managers-parent/galasa-managers-core-parent/dev.galasa.textscan.manager/src/main/java/dev/galasa/textscan/ILogScanner.java +++ b/galasa-managers-parent/galasa-managers-core-parent/dev.galasa.textscan.manager/src/main/java/dev/galasa/textscan/ILogScanner.java @@ -1,8 +1,8 @@ -/* - * Copyright contributors to the Galasa project - * - * SPDX-License-Identifier: EPL-2.0 - */ +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ package dev.galasa.textscan; import java.util.regex.Pattern; @@ -96,8 +96,8 @@ public interface ILogScanner { /** * Convenience method for scan(Pattern.Compile("\Q" + searchString + "\E"), Pattern.Compile("\Q" + failString + "\E"), count) * - * @param searchText The text to search for - * @param failText Failure text to search for, can be null meaning no fail search + * @param searchString The text to search for + * @param failString Failure text to search for, can be null meaning no fail search * @param count at least how many occurrences of the searchText must exist * @return This log scanner for fluent calls * @throws FailTextFoundException If the failText was found @@ -144,7 +144,7 @@ public interface ILogScanner { * * @param searchPattern The regex to search for * @param failPattern Failure regex to search for, can be null meaning no fail search - * @param occurrence The occurrence to be returned + * @param occurrance The occurrence to be returned * @return The text of the searchPattern found * @throws MissingTextException The searchPattern was not found at all * @throws IncorrectOccurrencesException If the specified occurrence was not found @@ -155,9 +155,9 @@ public interface ILogScanner { /** * Convenience method for scanForMatch(Pattern.Compile("\Q" + searchString + "\E"), Pattern.Compile("\Q" + searchString + "\E"), occurrence) * - * @param searchText The text to search for - * @param failText Failure text to search for, can be null meaning no fail search - * @param occurrence The occurrence to be returned + * @param searchString The text to search for + * @param failString Failure text to search for, can be null meaning no fail search + * @param occurrance The occurrence to be returned * @return The text of the searchPattern found * @throws MissingTextException The searchPattern was not found at all * @throws IncorrectOccurrencesException If the specified occurrence was not found @@ -172,7 +172,7 @@ public interface ILogScanner { * * @param searchPattern The regex to search for * @param failPattern Failure regex to search for, can be null meaning no fail search - * @param occurrence The occurrence to be returned + * @param occurrance The occurrence to be returned * @return The text of the searchPattern found * @throws MissingTextException The searchPattern was not found at all * @throws IncorrectOccurrencesException If the specified occurrence was not found @@ -183,9 +183,9 @@ public interface ILogScanner { /** * Convenience method for scanForMatchSinceCheckpoint(Pattern.Compile("\Q" + searchString + "\E"), Pattern.Compile("\Q" + searchString + "\E"), occurrence) * - * @param searchText The text to search for - * @param failText Failure text to search for, can be null meaning no fail search - * @param occurrence The occurrence to be returned + * @param searchString The text to search for + * @param failString Failure text to search for, can be null meaning no fail search + * @param occurrance The occurrence to be returned * @return The text of the searchPattern found * @throws MissingTextException The searchString was not found at all * @throws IncorrectOccurrencesException If the specified occurrence was not found diff --git a/galasa-managers-parent/galasa-managers-logging-parent/dev.galasa.elasticlog.manager/src/main/java/dev/galasa/elasticlog/internal/ElasticLogManagerImpl.java b/galasa-managers-parent/galasa-managers-logging-parent/dev.galasa.elasticlog.manager/src/main/java/dev/galasa/elasticlog/internal/ElasticLogManagerImpl.java index a818d7ea9..73ab1a4ca 100644 --- a/galasa-managers-parent/galasa-managers-logging-parent/dev.galasa.elasticlog.manager/src/main/java/dev/galasa/elasticlog/internal/ElasticLogManagerImpl.java +++ b/galasa-managers-parent/galasa-managers-logging-parent/dev.galasa.elasticlog.manager/src/main/java/dev/galasa/elasticlog/internal/ElasticLogManagerImpl.java @@ -71,10 +71,9 @@ public class ElasticLogManagerImpl extends AbstractManager { /** * Initialise the ElasticLogManager, adding a pointer to the other active managers * - * @param IFramework - the galasa framework - * @param List