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 cdca1d18f..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 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 e30b18096..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 @@ -12,187 +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. - * @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-comms-parent/dev.galasa.http.manager/src/main/java/dev/galasa/http/HttpClientResponse.java b/galasa-managers-parent/galasa-managers-comms-parent/dev.galasa.http.manager/src/main/java/dev/galasa/http/HttpClientResponse.java index 192a4de9d..7cc1a0d5b 100644 --- a/galasa-managers-parent/galasa-managers-comms-parent/dev.galasa.http.manager/src/main/java/dev/galasa/http/HttpClientResponse.java +++ b/galasa-managers-parent/galasa-managers-comms-parent/dev.galasa.http.manager/src/main/java/dev/galasa/http/HttpClientResponse.java @@ -240,11 +240,11 @@ public static HttpClientResponse textResponse(CloseableHttpResponse http } /** - * Create an {@link HttpClientResponse} with a <com.google.gson.JsonObject> content type + * Create an {@link HttpClientResponse} with a com.google.gson.JsonObject content type * from an {@link HttpResponse}. * * @param httpResponse - * @return - {@link HttpClientResponse} with a <com.google.gson.JsonObject> content type + * @return - {@link HttpClientResponse} with a com.google.gson.JsonObject content type * @throws HttpClientException */ public static HttpClientResponse jsonResponse(CloseableHttpResponse httpResponse) @@ -253,14 +253,14 @@ public static HttpClientResponse jsonResponse(CloseableHttpResponse } /** - * Create an {@link HttpClientResponse} with a <com.google.gson.JsonObject> content type + * Create an {@link HttpClientResponse} with a com.google.gson.JsonObject content type * from an {@link HttpResponse}. If contentOnBadResponse is true, an attempt * will be made to retrieve the content even on a non 200 status code, otherwise * the content will be null in such an instance. * * @param httpResponse * @param contentOnBadResponse - * @return - {@link HttpClientResponse} with a <com.google.gson.JsonObject> content type + * @return - {@link HttpClientResponse} with a com.google.gson.JsonObject content type * @throws HttpClientException */ public static HttpClientResponse jsonResponse(CloseableHttpResponse httpResponse, diff --git a/galasa-managers-parent/galasa-managers-comms-parent/dev.galasa.http.manager/src/main/java/dev/galasa/http/IHttpClient.java b/galasa-managers-parent/galasa-managers-comms-parent/dev.galasa.http.manager/src/main/java/dev/galasa/http/IHttpClient.java index bcd53f1ea..06438fb4f 100644 --- a/galasa-managers-parent/galasa-managers-comms-parent/dev.galasa.http.manager/src/main/java/dev/galasa/http/IHttpClient.java +++ b/galasa-managers-parent/galasa-managers-comms-parent/dev.galasa.http.manager/src/main/java/dev/galasa/http/IHttpClient.java @@ -122,54 +122,54 @@ HttpClientResponse postXML(String url, String xml) throws HttpClientException; /** - * Issue an HTTP GET to the provided URL, receiving a <com.google.gson.JsonObject> in the + * Issue an HTTP GET to the provided URL, receiving a com.google.gson.JsonObject in the * response. * * @param url - * @return - {@link HttpClientResponse} with a <com.google.gson.JsonObject> content type + * @return - {@link HttpClientResponse} with a com.google.gson.JsonObject content type * @throws HttpClientException */ HttpClientResponse getJson(String url) throws HttpClientException; /** * Issue an HTTP POST to the provided URL, sending the provided - * <com.google.gson.JsonObject> and receiving a <com.google.gson.JsonObject> in the response. + * com.google.gson.JsonObject and receiving a com.google.gson.JsonObject in the response. * * @param url * @param json - * @return - {@link HttpClientResponse} with a <com.google.gson.JsonObject> content type + * @return - {@link HttpClientResponse} with a com.google.gson.JsonObject content type * @throws HttpClientException */ HttpClientResponse postJson(String url, JsonObject json) throws HttpClientException; /** * Issue an HTTP PUT to the provided URL, sending the provided - * com.google.gson.JSONObject and receiving a com.google.gson.JSONObject in the response. + * com.google.gson.JsonObject and receiving a com.google.gson.JsonObject in the response. * * @param url * @param json - * @return - {@link HttpClientResponse} with a com.google.gson.JSONObject content type + * @return - {@link HttpClientResponse} with a com.google.gson.JsonObject content type * @throws HttpClientException */ HttpClientResponse putJson(String url, JsonObject json) throws HttpClientException; /** - * Issue an HTTP DELETE to the provided URL, receiving a <com.google.gson.JsonObject> in + * Issue an HTTP DELETE to the provided URL, receiving a com.google.gson.JsonObject in * the response. * * @param url - * @return - {@link HttpClientResponse} with a <com.google.gson.JsonObject> content type + * @return - {@link HttpClientResponse} with a com.google.gson.JsonObject content type * @throws HttpClientException */ HttpClientResponse deleteJson(String url) throws HttpClientException; /** - * Issue an HTTP DELETE to the provided URL, receiving a <com.google.gson.JsonObject> in + * Issue an HTTP DELETE to the provided URL, receiving a com.google.gson.JsonObject in * the response. * * @param url * @param json - * @return - {@link HttpClientResponse} with a <com.google.gson.JsonObject> content type + * @return - {@link HttpClientResponse} with a com.google.gson.JsonObject content type * @throws HttpClientException */ HttpClientResponse deleteJson(String url, JsonObject json) throws HttpClientException; @@ -222,7 +222,7 @@ HttpClientResponse postXML(String url, String xml) * * @param url * @param binary - * @return - {@link HttpClientResponse} with a <com.google.gson.JsonObject> content type + * @return - {@link HttpClientResponse} with a com.google.gson.JsonObject content type * @throws HttpClientException */ HttpClientResponse putBinary(String url, byte[] binary) throws HttpClientException; @@ -233,7 +233,7 @@ HttpClientResponse postXML(String url, String xml) * * @param url * @param binary - * @return - {@link HttpClientResponse} with a <com.google.gson.JsonObject> content type + * @return - {@link HttpClientResponse} with a com.google.gson.JsonObject content type * @throws HttpClientException */ HttpClientResponse getBinary(String url, byte[] binary) throws HttpClientException; @@ -244,7 +244,7 @@ HttpClientResponse postXML(String url, String xml) * * @param url * @param binary - * @return - {@link HttpClientResponse} with a <com.google.gson.JsonObject> content type + * @return - {@link HttpClientResponse} with a com.google.gson.JsonObject content type * @throws HttpClientException */ HttpClientResponse postBinary(String url, byte[] binary) throws HttpClientException; @@ -255,7 +255,7 @@ HttpClientResponse postXML(String url, String xml) * * @param url * @param binary - * @return - {@link HttpClientResponse} with a <com.google.gson.JsonObject> content type + * @return - {@link HttpClientResponse} with a com.google.gson.JsonObject content type * @throws HttpClientException */ HttpClientResponse deleteBinary(String url, byte[] binary) throws HttpClientException; diff --git a/galasa-managers-parent/galasa-managers-testingtools-parent/dev.galasa.jmeter.manager/src/main/java/dev/galasa/jmeter/IJMeterSession.java b/galasa-managers-parent/galasa-managers-testingtools-parent/dev.galasa.jmeter.manager/src/main/java/dev/galasa/jmeter/IJMeterSession.java index 6815c2aa6..c9eba0acd 100644 --- a/galasa-managers-parent/galasa-managers-testingtools-parent/dev.galasa.jmeter.manager/src/main/java/dev/galasa/jmeter/IJMeterSession.java +++ b/galasa-managers-parent/galasa-managers-testingtools-parent/dev.galasa.jmeter.manager/src/main/java/dev/galasa/jmeter/IJMeterSession.java @@ -60,9 +60,11 @@ public interface IJMeterSession { * JMX-files have to be prepared for this by replacing ALL the $P__VARIABLE notations with $VARIABLE notations * Then by adding neccesary parameters inside a HashMap with it, it is possible to change the target of a test dynamically inside the test * Example: - * HashMap<String,Object> map = new HashMap<String,Object>(); - * map.put("HOST", "galasa.dev"); - * session.setChangedParametersJmxFile(jmxStream, map); + * 
+        HashMap map = new HashMap();
+        map.put("HOST", "galasa.dev");
+        session.setChangedParametersJmxFile(jmxStream, map);
+
* @param jmxStream * @param parameters * @throws JMeterManagerException diff --git a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zos.manager/src/main/java/dev/galasa/zosbatch/IZosBatchJob.java b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zos.manager/src/main/java/dev/galasa/zosbatch/IZosBatchJob.java index c3ff97eac..14a32c0f9 100644 --- a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zos.manager/src/main/java/dev/galasa/zosbatch/IZosBatchJob.java +++ b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zos.manager/src/main/java/dev/galasa/zosbatch/IZosBatchJob.java @@ -66,7 +66,7 @@ public static JobStatus valueOfLabel(String jobStatus) { public String getOwner(); /** - * The type for this Job, i.e. JOB, STC or TSU. Returns "???" if no type has been associated + * The type for this Job, i.e. "JOB", "STC" or "TSU". Returns "???" if no type has been associated * * @return batch job type */ @@ -81,7 +81,7 @@ public static JobStatus valueOfLabel(String jobStatus) { /** * The batch job value as a {@link String}, e.g.
- * INPUT, ACTIVE, OUTPUT etc.
+ * "INPUT", "ACTIVE", "OUTPUT" etc.
* Returns "????????" if the job has not been submitted *

* N.B. Values are implementation dependent @@ -92,7 +92,7 @@ public static JobStatus valueOfLabel(String jobStatus) { /** * The batch job completion return code, e.g.
- * <code>CC 0000</code>, <code>CC 0020</code>, <code>JCL ERROR</code>, <code>ABEND S0C4</code> etc.<br> + * "CC 0000", "CC 0020", "JCL ERROR", "ABEND S0C4" etc. * Returns "????" if the job has not been submitted * * @return diff --git a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zosliberty.manager/src/main/java/dev/galasa/zosliberty/IZosLibertyServerXmlElementList.java b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zosliberty.manager/src/main/java/dev/galasa/zosliberty/IZosLibertyServerXmlElementList.java index 180da00e1..f4d806266 100644 --- a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zosliberty.manager/src/main/java/dev/galasa/zosliberty/IZosLibertyServerXmlElementList.java +++ b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zosliberty.manager/src/main/java/dev/galasa/zosliberty/IZosLibertyServerXmlElementList.java @@ -17,7 +17,7 @@ public interface IZosLibertyServerXmlElementList /** * Put an XML element in the element list * @param elementName - The name of the element to add - * @param attributes - A HashMap<String, String> of attributes + * @param attributes - A HashMap of attributes */ public void add(String elementName, Map attributes); diff --git a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zosprogram.manager/src/main/java/dev/galasa/zosprogram/ZosProgram.java b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zosprogram.manager/src/main/java/dev/galasa/zosprogram/ZosProgram.java index 174f3d7f1..ae9c40b7b 100644 --- a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zosprogram.manager/src/main/java/dev/galasa/zosprogram/ZosProgram.java +++ b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zosprogram.manager/src/main/java/dev/galasa/zosprogram/ZosProgram.java @@ -84,19 +84,19 @@ */ public enum Language { /** - * COBOL program with .cbl file extension + * COBOL program with ".cbl" file extension */ COBOL(".cbl"), /** - * C program with .c file extension + * C program with ".c" file extension */ C(".c"), /** - * PL1 program with .pl1 file extension + * PL1 program with ".pl1" file extension */ PL1(".pl1"), /** - * Assembler program with <code>.asm<\code> file extension + * Assembler program with ".asm" file extension */ ASSEMBLER(".asm"), /**