From ea02dd029d003beeb53f7c2182bdb290a697f6c1 Mon Sep 17 00:00:00 2001
From: aai <aai@kereval.com>
Date: Tue, 2 Nov 2021 17:03:47 +0100
Subject: [PATCH] Fix javadoc
---
.../java/net/ihe/gazelle/tempgen/action/AssertAnalyzer.java | 2 +-
.../ihe/gazelle/tempgen/action/HL7TemplatesConverter.java | 2 ++
.../net/ihe/gazelle/tempgen/valueset/script/SVSConsumer.java | 4 ++--
.../adapters/ArchetypeInstantiatorMaven.java | 4 ++++
.../adapters/GeneratedValidatorArchiverImpl.java | 1 +
.../lib/hl7templatespackager/adapters/ImportUpdaterImpl.java | 2 +-
.../lib/hl7templatespackager/adapters/UMLModelGenerator.java | 2 ++
.../adapters/ValidatorGeneratorPlugin.java | 5 +++++
.../hl7templatespackager/adapters/ValueSetExtractorImpl.java | 1 +
.../lib/hl7templatespackager/adapters/ZipUtility.java | 3 +++
.../lib/hl7templatespackager/application/GOCPackager.java | 1 +
.../application/ValidatorConfiguration.java | 4 ++--
.../lib/hl7templatespackager/peripherals/FileWriterImpl.java | 2 +-
.../hl7templatespackager/peripherals/FolderCreatorImpl.java | 4 ++--
.../lib/hl7templatespackager/peripherals/GOCLoggerImpl.java | 1 -
.../hl7templatespackager/peripherals/GOCPackagerFactory.java | 4 ++++
16 files changed, 32 insertions(+), 10 deletions(-)
diff --git a/hl7templates/hl7templates-generator-jar/src/main/java/net/ihe/gazelle/tempgen/action/AssertAnalyzer.java b/hl7templates/hl7templates-generator-jar/src/main/java/net/ihe/gazelle/tempgen/action/AssertAnalyzer.java
index ea0fc00..b21f6f1 100644
--- a/hl7templates/hl7templates-generator-jar/src/main/java/net/ihe/gazelle/tempgen/action/AssertAnalyzer.java
+++ b/hl7templates/hl7templates-generator-jar/src/main/java/net/ihe/gazelle/tempgen/action/AssertAnalyzer.java
@@ -448,7 +448,7 @@ public class AssertAnalyzer extends AssertProcessorImpl {
/**
* Process the XPATH assertion and return it as an OwnedRule
* Mainly used for choices handling
- * @param test XPATH assertion (Ex: effectiveTime[@xsi:type='CD'] => test="@xsi:type='CD'")
+ * @param test XPATH assertion (Ex: effectiveTime[@xsi:type='CD'] => test="@xsi:type='CD'")
* @param element element holding the test
* @param pe [NULLABLE] temporary used package for generation rules
* @return returns the generated ownedRule
diff --git a/hl7templates/hl7templates-generator-jar/src/main/java/net/ihe/gazelle/tempgen/action/HL7TemplatesConverter.java b/hl7templates/hl7templates-generator-jar/src/main/java/net/ihe/gazelle/tempgen/action/HL7TemplatesConverter.java
index c90093e..258b1ca 100644
--- a/hl7templates/hl7templates-generator-jar/src/main/java/net/ihe/gazelle/tempgen/action/HL7TemplatesConverter.java
+++ b/hl7templates/hl7templates-generator-jar/src/main/java/net/ihe/gazelle/tempgen/action/HL7TemplatesConverter.java
@@ -28,6 +28,7 @@ public class HL7TemplatesConverter {
* Default conversion of BBR to UML. Base options are ignoreTemplateIdRequirements = true and versionLabel = null
* @param bbrpath : path to the BBR to convert
* @throws JAXBException if decor cannot be unmarshall
+ * @return the XMI String
*/
public String convertArtDecorXMI(String bbrpath) throws JAXBException {
return convertArtDecorXMI(bbrpath, false, null);
@@ -39,6 +40,7 @@ public class HL7TemplatesConverter {
* @param ignoreTemplateIdRequirements : if true, no rule for templateId will be generated in the UML model
* @param templateVersionFilter : only templates defining this version label will be kept in the model (ignored if null)
* @throws JAXBException if decor cannot be unmarshall
+ * @return The XMI String
*/
public String convertArtDecorXMI(String bbrpath, boolean ignoreTemplateIdRequirements, String templateVersionFilter)
throws JAXBException {
diff --git a/hl7templates/hl7templates-generator-jar/src/main/java/net/ihe/gazelle/tempgen/valueset/script/SVSConsumer.java b/hl7templates/hl7templates-generator-jar/src/main/java/net/ihe/gazelle/tempgen/valueset/script/SVSConsumer.java
index 5547c28..c40df48 100644
--- a/hl7templates/hl7templates-generator-jar/src/main/java/net/ihe/gazelle/tempgen/valueset/script/SVSConsumer.java
+++ b/hl7templates/hl7templates-generator-jar/src/main/java/net/ihe/gazelle/tempgen/valueset/script/SVSConsumer.java
@@ -25,8 +25,8 @@ public class SVSConsumer {
/**
*
- * @param valueSetId
- * @return
+ * @param valueSetId the valueSet Id
+ * @return List of retrieved concepts
*/
public List<Concept> getConceptsListFromValueSet(String valueSetId, String lang) {
if (listConcept.get(valueSetId + lang) != null) {
diff --git a/hl7templates/hl7templates-packager-jar/src/main/java/net/ihe/gazelle/lib/hl7templatespackager/adapters/ArchetypeInstantiatorMaven.java b/hl7templates/hl7templates-packager-jar/src/main/java/net/ihe/gazelle/lib/hl7templatespackager/adapters/ArchetypeInstantiatorMaven.java
index f9ebb02..672e856 100644
--- a/hl7templates/hl7templates-packager-jar/src/main/java/net/ihe/gazelle/lib/hl7templatespackager/adapters/ArchetypeInstantiatorMaven.java
+++ b/hl7templates/hl7templates-packager-jar/src/main/java/net/ihe/gazelle/lib/hl7templatespackager/adapters/ArchetypeInstantiatorMaven.java
@@ -41,6 +41,10 @@ public class ArchetypeInstantiatorMaven implements ArchetypeInstantiator {
/**
* Creates an instance of the class with a defined root path to create archetypes instances.
* @param workspacesRoot : root path where workspaces will be created.
+ * @param mvnExecutionPath : binary path for maven
+ * @param gocLogger : The instance of the logger
+ * @param processExecutor : The instance of the process Executor
+ * @param valueSetExtractor : The instance of the valueSet Extractor
*/
public ArchetypeInstantiatorMaven(String workspacesRoot, String mvnExecutionPath, GOCLogger gocLogger, ProcessExecutor processExecutor,
ValueSetExtractor valueSetExtractor){
diff --git a/hl7templates/hl7templates-packager-jar/src/main/java/net/ihe/gazelle/lib/hl7templatespackager/adapters/GeneratedValidatorArchiverImpl.java b/hl7templates/hl7templates-packager-jar/src/main/java/net/ihe/gazelle/lib/hl7templatespackager/adapters/GeneratedValidatorArchiverImpl.java
index 27d67fc..09c404b 100644
--- a/hl7templates/hl7templates-packager-jar/src/main/java/net/ihe/gazelle/lib/hl7templatespackager/adapters/GeneratedValidatorArchiverImpl.java
+++ b/hl7templates/hl7templates-packager-jar/src/main/java/net/ihe/gazelle/lib/hl7templatespackager/adapters/GeneratedValidatorArchiverImpl.java
@@ -25,6 +25,7 @@ public class GeneratedValidatorArchiverImpl implements GeneratedValidatorArchive
/**
* Public constructor for the class
+ * @param workspacesRoot workspace root
*/
public GeneratedValidatorArchiverImpl(String workspacesRoot){
setWorkspacesRoot(workspacesRoot);
diff --git a/hl7templates/hl7templates-packager-jar/src/main/java/net/ihe/gazelle/lib/hl7templatespackager/adapters/ImportUpdaterImpl.java b/hl7templates/hl7templates-packager-jar/src/main/java/net/ihe/gazelle/lib/hl7templatespackager/adapters/ImportUpdaterImpl.java
index 2c80d10..121893e 100644
--- a/hl7templates/hl7templates-packager-jar/src/main/java/net/ihe/gazelle/lib/hl7templatespackager/adapters/ImportUpdaterImpl.java
+++ b/hl7templates/hl7templates-packager-jar/src/main/java/net/ihe/gazelle/lib/hl7templatespackager/adapters/ImportUpdaterImpl.java
@@ -62,7 +62,7 @@ public class ImportUpdaterImpl implements ImportUpdater {
* Update imports in generated validator classes to import model classes based on which configuration is used.
* @param workspace : workspace where the java code will be generated.
* @param validatorConfiguration : holds the name of the project that will be used to generate the java code.
- * @throws IOException
+ * @throws IOException Throws IOException if updating failed
*/
@Override
public void updateImportsForValidator(Workspace workspace, ValidatorConfiguration validatorConfiguration) throws IOException {
diff --git a/hl7templates/hl7templates-packager-jar/src/main/java/net/ihe/gazelle/lib/hl7templatespackager/adapters/UMLModelGenerator.java b/hl7templates/hl7templates-packager-jar/src/main/java/net/ihe/gazelle/lib/hl7templatespackager/adapters/UMLModelGenerator.java
index 355f84a..e56aa17 100644
--- a/hl7templates/hl7templates-packager-jar/src/main/java/net/ihe/gazelle/lib/hl7templatespackager/adapters/UMLModelGenerator.java
+++ b/hl7templates/hl7templates-packager-jar/src/main/java/net/ihe/gazelle/lib/hl7templatespackager/adapters/UMLModelGenerator.java
@@ -36,6 +36,7 @@ public class UMLModelGenerator implements ModelGenerator {
/**
* Creates an instance of the class with a defined root path to workspaces.
* @param workspacesRoot : root path where workspaces will be created.
+ * @param gocLogger : The instance of the logger
*/
public UMLModelGenerator(String workspacesRoot, GOCLogger gocLogger){
setWorkspacesRoot(workspacesRoot);
@@ -45,6 +46,7 @@ public class UMLModelGenerator implements ModelGenerator {
/**
* Getter for the workspaceRoot property.
+ * @return the workspace root
*/
public String getWorkspacesRoot() {
if (this.workspacesRoot != null){
diff --git a/hl7templates/hl7templates-packager-jar/src/main/java/net/ihe/gazelle/lib/hl7templatespackager/adapters/ValidatorGeneratorPlugin.java b/hl7templates/hl7templates-packager-jar/src/main/java/net/ihe/gazelle/lib/hl7templatespackager/adapters/ValidatorGeneratorPlugin.java
index 0a9c6a6..9b4b32d 100644
--- a/hl7templates/hl7templates-packager-jar/src/main/java/net/ihe/gazelle/lib/hl7templatespackager/adapters/ValidatorGeneratorPlugin.java
+++ b/hl7templates/hl7templates-packager-jar/src/main/java/net/ihe/gazelle/lib/hl7templatespackager/adapters/ValidatorGeneratorPlugin.java
@@ -35,9 +35,14 @@ public class ValidatorGeneratorPlugin implements ValidatorGenerator {
private ValidatorGeneratorPlugin(){
}
+
/**
* Creates an instance of the class with a defined root path to create workspaces.
* @param workspacesRoot : root path where workspaces will be created.
+ * @param mvnExecutionPath : path of binary maven
+ * @param gocLogger : The instance of the logger
+ * @param processExecutor : The instance of the executor
+ * @param validatorRightUpdater : The instance of the rightUpdater
*/
public ValidatorGeneratorPlugin(String workspacesRoot, String mvnExecutionPath, GOCLogger gocLogger, ProcessExecutor processExecutor,
ValidatorRightUpdater validatorRightUpdater){
diff --git a/hl7templates/hl7templates-packager-jar/src/main/java/net/ihe/gazelle/lib/hl7templatespackager/adapters/ValueSetExtractorImpl.java b/hl7templates/hl7templates-packager-jar/src/main/java/net/ihe/gazelle/lib/hl7templatespackager/adapters/ValueSetExtractorImpl.java
index 8dfdd5e..1580276 100644
--- a/hl7templates/hl7templates-packager-jar/src/main/java/net/ihe/gazelle/lib/hl7templatespackager/adapters/ValueSetExtractorImpl.java
+++ b/hl7templates/hl7templates-packager-jar/src/main/java/net/ihe/gazelle/lib/hl7templatespackager/adapters/ValueSetExtractorImpl.java
@@ -34,6 +34,7 @@ public class ValueSetExtractorImpl implements ValueSetExtractor {
/**
* Getter for workspaceRoot property.
+ * @return workspace root
*/
public String getWorkspaceRoot() {
if (workspaceRoot != null){
diff --git a/hl7templates/hl7templates-packager-jar/src/main/java/net/ihe/gazelle/lib/hl7templatespackager/adapters/ZipUtility.java b/hl7templates/hl7templates-packager-jar/src/main/java/net/ihe/gazelle/lib/hl7templatespackager/adapters/ZipUtility.java
index d8a8031..4061e8e 100644
--- a/hl7templates/hl7templates-packager-jar/src/main/java/net/ihe/gazelle/lib/hl7templatespackager/adapters/ZipUtility.java
+++ b/hl7templates/hl7templates-packager-jar/src/main/java/net/ihe/gazelle/lib/hl7templatespackager/adapters/ZipUtility.java
@@ -93,6 +93,9 @@ public class ZipUtility {
/**
* copie le fichier source dans le fichier resultat retourne vrai si cela réussit
+ * @param source source File
+ * @param dest destination File
+ * @return true if copying is done, else false
*/
public static boolean copyFile(File source, File dest) {
try {
diff --git a/hl7templates/hl7templates-packager-jar/src/main/java/net/ihe/gazelle/lib/hl7templatespackager/application/GOCPackager.java b/hl7templates/hl7templates-packager-jar/src/main/java/net/ihe/gazelle/lib/hl7templatespackager/application/GOCPackager.java
index e087683..47dd60a 100644
--- a/hl7templates/hl7templates-packager-jar/src/main/java/net/ihe/gazelle/lib/hl7templatespackager/application/GOCPackager.java
+++ b/hl7templates/hl7templates-packager-jar/src/main/java/net/ihe/gazelle/lib/hl7templatespackager/application/GOCPackager.java
@@ -49,6 +49,7 @@ public class GOCPackager {
* Entry point of the whole packaging process to create a validator
* @param workspace : workspace for the generation.
* @param validatorConfiguration : ValidatorConfiguration used for the generation.
+ * @throws PackagerProcessException throws a PackagerProcessException if one of main operations failed
*/
public void packageBBRToGOCValidationTool(Workspace workspace, ValidatorConfiguration validatorConfiguration)
throws PackagerProcessException {
diff --git a/hl7templates/hl7templates-packager-jar/src/main/java/net/ihe/gazelle/lib/hl7templatespackager/application/ValidatorConfiguration.java b/hl7templates/hl7templates-packager-jar/src/main/java/net/ihe/gazelle/lib/hl7templatespackager/application/ValidatorConfiguration.java
index af2fbc8..f91ee6f 100644
--- a/hl7templates/hl7templates-packager-jar/src/main/java/net/ihe/gazelle/lib/hl7templatespackager/application/ValidatorConfiguration.java
+++ b/hl7templates/hl7templates-packager-jar/src/main/java/net/ihe/gazelle/lib/hl7templatespackager/application/ValidatorConfiguration.java
@@ -142,7 +142,7 @@ public class ValidatorConfiguration {
/**
* Setter for the serviceName property directly from the input string.
*
- * @param serviceName
+ * @param serviceName service name
*/
public void setServiceName(String serviceName) {
this.serviceName = serviceName;
@@ -160,7 +160,7 @@ public class ValidatorConfiguration {
/**
* Setter for the projectNaming property directly from the input string.
*
- * @param projectNaming
+ * @param projectNaming project naming
*/
public void setProjectNaming(ProjectNaming projectNaming) {
this.projectNaming = projectNaming;
diff --git a/hl7templates/hl7templates-packager-jar/src/main/java/net/ihe/gazelle/lib/hl7templatespackager/peripherals/FileWriterImpl.java b/hl7templates/hl7templates-packager-jar/src/main/java/net/ihe/gazelle/lib/hl7templatespackager/peripherals/FileWriterImpl.java
index 6c2c8df..e4f1849 100644
--- a/hl7templates/hl7templates-packager-jar/src/main/java/net/ihe/gazelle/lib/hl7templatespackager/peripherals/FileWriterImpl.java
+++ b/hl7templates/hl7templates-packager-jar/src/main/java/net/ihe/gazelle/lib/hl7templatespackager/peripherals/FileWriterImpl.java
@@ -11,7 +11,7 @@ public class FileWriterImpl implements FileWriter {
* Write the content of a resource from an URL to a specific file.
* @param resourceURL : URL of the resource to write in the file.
* @param fileOutputPath : path of the file where the resource will be written.
- * @throws IOException
+ * @throws IOException throws IOException if writing failed
*/
public void writeContentInFile(URL resourceURL, String fileOutputPath) throws IOException{
try (InputStream resourceInputStream = resourceURL.openStream()) {
diff --git a/hl7templates/hl7templates-packager-jar/src/main/java/net/ihe/gazelle/lib/hl7templatespackager/peripherals/FolderCreatorImpl.java b/hl7templates/hl7templates-packager-jar/src/main/java/net/ihe/gazelle/lib/hl7templatespackager/peripherals/FolderCreatorImpl.java
index f7dfd85..fa62eb3 100644
--- a/hl7templates/hl7templates-packager-jar/src/main/java/net/ihe/gazelle/lib/hl7templatespackager/peripherals/FolderCreatorImpl.java
+++ b/hl7templates/hl7templates-packager-jar/src/main/java/net/ihe/gazelle/lib/hl7templatespackager/peripherals/FolderCreatorImpl.java
@@ -26,7 +26,7 @@ public class FolderCreatorImpl implements FolderCreator {
* Reset the folder at path given in parameter. This means if it exist it will delete it and create it again. If it does not already
* exists, it will simply create it.
* @param folderToResetPath : path to the folder to reset.
- * @throws IOException
+ * @throws IOException throw IOException if the reset failed
*/
public void resetFolder(String folderToResetPath) throws IOException {
File folderToReset = new File(folderToResetPath);
@@ -47,7 +47,7 @@ public class FolderCreatorImpl implements FolderCreator {
/**
* Create a folder at given path. Does nothing if folder already exists.
* @param folderToCreatePath : path to the folder to create.
- * @throws IOException
+ * @throws IOException throws and IOException if the creation failed
*/
public void createFolder(String folderToCreatePath) throws IOException {
File folderToCreate = new File(folderToCreatePath);
diff --git a/hl7templates/hl7templates-packager-jar/src/main/java/net/ihe/gazelle/lib/hl7templatespackager/peripherals/GOCLoggerImpl.java b/hl7templates/hl7templates-packager-jar/src/main/java/net/ihe/gazelle/lib/hl7templatespackager/peripherals/GOCLoggerImpl.java
index d2947f7..1f513f9 100644
--- a/hl7templates/hl7templates-packager-jar/src/main/java/net/ihe/gazelle/lib/hl7templatespackager/peripherals/GOCLoggerImpl.java
+++ b/hl7templates/hl7templates-packager-jar/src/main/java/net/ihe/gazelle/lib/hl7templatespackager/peripherals/GOCLoggerImpl.java
@@ -86,7 +86,6 @@ public class GOCLoggerImpl implements GOCLogger {
* Log the output of the process
* @param inputStream : the input stream to be logged
* @param errorStream : the error stream to be logged
- * @throws IOException
*/
@Override
public void logExecutionOutput(InputStream inputStream, InputStream errorStream, String command) {
diff --git a/hl7templates/hl7templates-packager-jar/src/main/java/net/ihe/gazelle/lib/hl7templatespackager/peripherals/GOCPackagerFactory.java b/hl7templates/hl7templates-packager-jar/src/main/java/net/ihe/gazelle/lib/hl7templatespackager/peripherals/GOCPackagerFactory.java
index 79cfb7c..83da305 100644
--- a/hl7templates/hl7templates-packager-jar/src/main/java/net/ihe/gazelle/lib/hl7templatespackager/peripherals/GOCPackagerFactory.java
+++ b/hl7templates/hl7templates-packager-jar/src/main/java/net/ihe/gazelle/lib/hl7templatespackager/peripherals/GOCPackagerFactory.java
@@ -24,6 +24,10 @@ public class GOCPackagerFactory {
* Generate an instance of GOCPackager able to generate validators in a given workspace.
* @param workspacesRoot : root path for the workspaces that will be used for generation
* @param mvnExecutionPath : path to maven execution (eg: mvn)
+ * @param generationDate : generation date, used for creating logs folder
+ * @param gocLogger : The instance of the logger
+ * @param processExecutor : the instance of the process executor
+ * @return returns the packager
*/
public GOCPackager createGOCPackager(String workspacesRoot, String mvnExecutionPath, String generationDate, GOCLogger gocLogger,
ProcessExecutor processExecutor){
--
GitLab