diff options
author | mark.j.leonard <mark.j.leonard@gmail.com> | 2018-08-06 17:28:51 +0100 |
---|---|---|
committer | mark.j.leonard <mark.j.leonard@gmail.com> | 2018-08-06 17:53:51 +0100 |
commit | 08f6801fc93c4b39a8e870974100cd24ec9450a0 (patch) | |
tree | 44a42dfbfe9eac22fecf3267ba485ab9a52c4249 | |
parent | 1bde7e38ed218f9ba337ee5cd9acfe524206e996 (diff) |
Minor text fixes
Updated some Javadoc text for compatibility with Checkstyle settings.
Issue-ID: AAI-1444
Change-Id: I9d7541aa24d07e42d7d127f76b8576a7fa7184d4
Signed-off-by: mark.j.leonard <mark.j.leonard@gmail.com>
6 files changed, 19 insertions, 7 deletions
diff --git a/src/main/java/org/onap/aai/babel/csar/CsarConverterException.java b/src/main/java/org/onap/aai/babel/csar/CsarConverterException.java index eb81014..12b324e 100644 --- a/src/main/java/org/onap/aai/babel/csar/CsarConverterException.java +++ b/src/main/java/org/onap/aai/babel/csar/CsarConverterException.java @@ -21,7 +21,7 @@ package org.onap.aai.babel.csar; /** - * This class represents an exception encountered when attempting to convert the yml files in a csar archive into xml. + * This class represents an exception encountered when attempting to convert the YAML files in a CSAR archive into XML. */ public class CsarConverterException extends Exception { diff --git a/src/main/java/org/onap/aai/babel/csar/vnfcatalog/VnfVendorImageExtractor.java b/src/main/java/org/onap/aai/babel/csar/vnfcatalog/VnfVendorImageExtractor.java index eb841e6..d98c622 100644 --- a/src/main/java/org/onap/aai/babel/csar/vnfcatalog/VnfVendorImageExtractor.java +++ b/src/main/java/org/onap/aai/babel/csar/vnfcatalog/VnfVendorImageExtractor.java @@ -30,6 +30,7 @@ import java.util.Map.Entry; import java.util.Objects; import java.util.function.Consumer; import java.util.stream.Collectors; + import org.apache.commons.io.FileUtils; import org.apache.commons.lang3.time.StopWatch; import org.apache.commons.lang3.tuple.ImmutablePair; diff --git a/src/test/java/org/onap/aai/babel/logging/LogReader.java b/src/test/java/org/onap/aai/babel/logging/LogReader.java index 21a3d1d..1e84b62 100644 --- a/src/test/java/org/onap/aai/babel/logging/LogReader.java +++ b/src/test/java/org/onap/aai/babel/logging/LogReader.java @@ -18,6 +18,7 @@ * limitations under the License. * ============LICENSE_END========================================================= */ + package org.onap.aai.babel.logging; import java.io.BufferedReader; @@ -32,6 +33,7 @@ import java.util.HashMap; import java.util.Map; import java.util.Optional; import java.util.concurrent.TimeUnit; + import org.apache.commons.lang3.time.StopWatch; import org.junit.Assert; @@ -58,9 +60,15 @@ public class LogReader { } /** + * Find the most recently modified log file with a name starting with the specified prefix. + * * @param logDirectory - * @return the most recently created log file. + * the root folder storing log files + * @param filenamePrefix + * the log file name prefix + * @return the most recently created log file * @throws IOException + * if an I/O error occurs */ public File getLogFile(String logDirectory, String filenamePrefix) throws IOException { Path cachedLog = cachedLogMap.get(filenamePrefix); @@ -82,7 +90,8 @@ public class LogReader { * Wait for and read new log entries. * * @return new lines appended to the log file - * @throws IOException If an I/O error occurs + * @throws IOException + * If an I/O error occurs */ public String getNewLines() throws IOException { StopWatch stopwatch = new StopWatch(); diff --git a/src/test/java/org/onap/aai/babel/parser/TestToscaParser.java b/src/test/java/org/onap/aai/babel/parser/TestToscaParser.java index a73e64c..93b3576 100644 --- a/src/test/java/org/onap/aai/babel/parser/TestToscaParser.java +++ b/src/test/java/org/onap/aai/babel/parser/TestToscaParser.java @@ -43,7 +43,7 @@ import org.onap.aai.babel.xml.generator.data.GenerationData; import org.onap.aai.babel.xml.generator.data.WidgetConfigurationUtil; /** - * Direct tests of the Model so as to improve code coverage + * Direct tests of the Model to improve code coverage. */ public class TestToscaParser { diff --git a/src/test/java/org/onap/aai/babel/service/TestRequestHeaders.java b/src/test/java/org/onap/aai/babel/service/TestRequestHeaders.java index 0d81867..44cc9d4 100644 --- a/src/test/java/org/onap/aai/babel/service/TestRequestHeaders.java +++ b/src/test/java/org/onap/aai/babel/service/TestRequestHeaders.java @@ -45,7 +45,7 @@ public class TestRequestHeaders { * Tests compatibility with the X-ECOMP-* request headers. */ @Test - public void testECOMPHeaders() { + public void testEcompHeaders() { String transactionId = "transaction-id"; String serviceInstanceId = "service-instance-id"; diff --git a/src/test/java/org/onap/aai/babel/xml/generator/model/TestWidget.java b/src/test/java/org/onap/aai/babel/xml/generator/model/TestWidget.java index 81db946..07b93b0 100644 --- a/src/test/java/org/onap/aai/babel/xml/generator/model/TestWidget.java +++ b/src/test/java/org/onap/aai/babel/xml/generator/model/TestWidget.java @@ -49,8 +49,10 @@ public class TestWidget { /** * Load the Widget to UUID mappings from the Artifact Generator properties. * - * @throws FileNotFoundException if the properties file is missing - * @throws IOException if the properties file is not loaded + * @throws FileNotFoundException + * if the properties file is missing + * @throws IOException + * if the properties file is not loaded */ @BeforeClass public static void setup() throws FileNotFoundException, IOException { |