updated javadocs

This commit is contained in:
Brian Long 2023-11-15 17:01:39 -05:00
parent bd5b218509
commit 8bb15894e8
6 changed files with 8 additions and 7 deletions

View File

@ -33,8 +33,7 @@ public class ApsTemplateCrawler {
private final boolean failOnIntegrityViolation;
/**
* @param apsAppName A name for the APS App.
* @param apsAppDirectory A directory to the unpacked APS App export.
* @param apsTemplateDirectory A directory to the APS template files.
* @param failOnIntegrityViolation true to fail on file integrity issues; false to log warnings.
*/
public ApsTemplateCrawler(File apsTemplateDirectory, boolean failOnIntegrityViolation) {

View File

@ -120,6 +120,8 @@ public abstract class ApsAddressibleGoal extends DisablableGoal {
}
/**
* This method constructs and caches the APS API accessor.
*
* @return An APS API instance.
*/
public synchronized ApsPublicRestApiJerseyImpl getApsApi() {

View File

@ -37,8 +37,6 @@ public class ApsTemplateJsonTranslator implements ApsFileTranslator {
/**
* This constructor initializes the default translator.
*
* @param api An APS API reference.
*/
public ApsTemplateJsonTranslator(
Index<Long, String> apsDocumentTemplateIndex,

View File

@ -35,6 +35,8 @@ import com.fasterxml.jackson.databind.ObjectMapper;
* `allowDuplicateValues` to `false`.
*
* @author brian@inteligr8.com
* @param <K> An index key type.
* @param <V> An index value type.
*/
public class Index<K, V> {

View File

@ -28,6 +28,8 @@ import java.util.Map;
* any sorted list.
*
* @author brian@inteligr8.com
* @param <K> An map key type.
* @param <V> An map value type.
*/
public class MapComparator<K, V> implements Comparator<Map<K, V>> {

View File

@ -304,7 +304,6 @@ public class ModelUtil {
*
* @param o A Java POJO.
* @return A JSON node (array, object, or value).
* @throws IOException A stream I/O issue occurred.
*/
public ObjectNode readPojo(Object o) {
return this.om.convertValue(o, ObjectNode.class);
@ -417,9 +416,8 @@ public class ModelUtil {
* @param map A Java map.
* @param type A Java class to create.
* @return A Java POJO instance.
* @throws IOException A file I/O issue occurred.
*/
public <T> T writePojo(Map<String, Object> map, Class<T> type) throws IOException {
public <T> T writePojo(Map<String, Object> map, Class<T> type) {
return this.om.convertValue(map, type);
}