updated javadocs

Erudika · Apr 27, 2024 · 37fbaa6 · 37fbaa6
1 parent d758faa
commit 37fbaa6
Show file tree

Hide file tree

Showing 20 changed files with 192 additions and 29 deletions.
diff --git a/para-core/src/main/java-templates/com/erudika/para/utils/Version.java b/para-core/src/main/java-templates/com/erudika/para/utils/Version.java
@@ -30,6 +30,8 @@ public final class Version {
 	private static final String GIT_BRANCH = "${scmBranch}";
 	private static final String REVISION = "${buildNumber}";
 
+	private Version() { }
+
 	public static String getVersion() {
 		return VERSION;
 	}

diff --git a/para-server/src/main/java/com/erudika/para/server/ParaServer.java b/para-server/src/main/java/com/erudika/para/server/ParaServer.java
@@ -234,6 +234,7 @@ public int getOrder() {
 	}
 
 	/**
+	 * Filter.
 	 * @return API servlet bean
 	 */
 	@Bean
@@ -249,6 +250,7 @@ public ServletRegistrationBean<?> apiV1RegistrationBean() {
 	}
 
 	/**
+	 * Filter.
 	 * @return GZIP filter bean
 	 */
 	@Bean
@@ -265,6 +267,7 @@ public FilterRegistrationBean<?> gzipFilterRegistrationBean() {
 	}
 
 	/**
+	 * Filter.
 	 * @return CORS filter bean
 	 */
 	@Bean
@@ -287,6 +290,7 @@ public FilterRegistrationBean<?> corsFilterRegistrationBean() {
 	}
 
 	/**
+	 * Jetty config.
 	 * @return Jetty config bean
 	 */
 	@Bean

diff --git a/para-server/src/main/java/com/erudika/para/server/aop/AOPModule.java b/para-server/src/main/java/com/erudika/para/server/aop/AOPModule.java
@@ -28,6 +28,12 @@
  */
 public class AOPModule extends AbstractModule {
 
+	/**
+	 * Default constructor.
+	 */
+	public AOPModule() {
+	}
+
 	protected void configure() {
 		// enable automatic indexing and caching each time an object is created/updated
 		IndexAndCacheAspect coreAspect = new IndexAndCacheAspect();

diff --git a/para-server/src/main/java/com/erudika/para/server/aop/IndexAndCacheAspect.java b/para-server/src/main/java/com/erudika/para/server/aop/IndexAndCacheAspect.java
@@ -17,17 +17,18 @@
  */
 package com.erudika.para.server.aop;
 
-import com.erudika.para.core.listeners.IOListener;
-import com.erudika.para.core.utils.Para;
+import com.erudika.para.core.ParaObject;
 import com.erudika.para.core.annotations.Cached;
 import com.erudika.para.core.annotations.Indexed;
 import com.erudika.para.core.cache.Cache;
-import com.erudika.para.core.ParaObject;
+import com.erudika.para.core.listeners.IOListener;
 import com.erudika.para.core.metrics.Metrics;
 import com.erudika.para.core.persistence.DAO;
 import com.erudika.para.core.search.Search;
+import com.erudika.para.core.utils.Para;
 import com.erudika.para.core.utils.Utils;
 import com.erudika.para.core.validation.ValidationUtils;
+import jakarta.inject.Inject;
 import java.lang.reflect.Method;
 import java.lang.reflect.Modifier;
 import java.util.ArrayList;
@@ -38,7 +39,6 @@
 import java.util.Map;
 import java.util.Set;
 import java.util.stream.Collectors;
-import jakarta.inject.Inject;
 import org.aopalliance.intercept.MethodInterceptor;
 import org.aopalliance.intercept.MethodInvocation;
 import org.slf4j.Logger;
@@ -62,13 +62,21 @@ public class IndexAndCacheAspect implements MethodInterceptor {
 	private Cache cache;
 
 	/**
+	 * Constructor.
+	 */
+	public IndexAndCacheAspect() {
+	}
+
+	/**
+	 * getter/setter.
 	 * @return {@link Search}
 	 */
 	public Search getSearch() {
 		return search;
 	}
 
 	/**
+	 * getter/setter.
 	 * @param search {@link Search}
 	 */
 	@Inject
@@ -77,13 +85,15 @@ public void setSearch(Search search) {
 	}
 
 	/**
+	 * getter/setter.
 	 * @return {@link Cache}
 	 */
 	public Cache getCache() {
 		return cache;
 	}
 
 	/**
+	 * getter/setter.
 	 * @param cache {@link Cache}
 	 */
 	@Inject

diff --git a/para-server/src/main/java/com/erudika/para/server/cache/CacheModule.java b/para-server/src/main/java/com/erudika/para/server/cache/CacheModule.java
@@ -29,6 +29,12 @@
  */
 public class CacheModule extends AbstractModule {
 
+	/**
+	 * Constructor.
+	 */
+	public CacheModule() {
+	}
+
 	protected void configure() {
 		String selectedCache = Para.getConfig().cachePlugin();
 		if (StringUtils.isBlank(selectedCache) || "inmemory".equalsIgnoreCase(selectedCache)) {

diff --git a/para-server/src/main/java/com/erudika/para/server/email/EmailModule.java b/para-server/src/main/java/com/erudika/para/server/email/EmailModule.java
@@ -29,6 +29,12 @@
  */
 public class EmailModule extends AbstractModule {
 
+	/**
+	 * Constructor.
+	 */
+	public EmailModule() {
+	}
+
 	protected void configure() {
 		String selectedEmailer = Para.getConfig().emailerPlugin();
 		if (StringUtils.isBlank(selectedEmailer)) {

diff --git a/para-server/src/main/java/com/erudika/para/server/email/NoopEmailer.java b/para-server/src/main/java/com/erudika/para/server/email/NoopEmailer.java
@@ -31,6 +31,12 @@ public class NoopEmailer implements Emailer {
 
 	private static final Logger logger = LoggerFactory.getLogger(NoopEmailer.class);
 
+	/**
+	 * Constructor.
+	 */
+	public NoopEmailer() {
+	}
+
 	@Override
 	public boolean sendEmail(List<String> emails, String subject, String body) {
 		logger.info("EMAIL SENT: {}, {}, {}", emails, subject, body);

diff --git a/para-server/src/main/java/com/erudika/para/server/queue/LocalQueue.java b/para-server/src/main/java/com/erudika/para/server/queue/LocalQueue.java
@@ -21,17 +21,17 @@
 import com.erudika.para.core.queue.MockQueue;
 import com.erudika.para.core.queue.Queue;
 import com.erudika.para.core.utils.Para;
+import jakarta.inject.Singleton;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.concurrent.ConcurrentLinkedQueue;
 import java.util.concurrent.Future;
-import jakarta.inject.Singleton;
 import org.apache.commons.lang3.StringUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 /**
- *
+ * Local queue impl.
  * @author Alex Bogdanovski [alex@erudika.com]
  */
 @Singleton
@@ -54,6 +54,7 @@ public LocalQueue() {
 	}
 
 	/**
+	 * getter/setter.
 	 * @param name name
 	 */
 	public LocalQueue(String name) {

diff --git a/para-server/src/main/java/com/erudika/para/server/rest/Api1.java b/para-server/src/main/java/com/erudika/para/server/rest/Api1.java
@@ -381,6 +381,7 @@ public Response apply(ContainerRequestContext ctx) {
 	}
 
 	/**
+	 * Api method.
 	 * @param app {@link App}
 	 * @param type a type
 	 * @return response
@@ -414,6 +415,7 @@ public Response apply(ContainerRequestContext ctx) {
 	}
 
 	/**
+	 * Api method.
 	 * @return response
 	 */
 	public static Inflector<ContainerRequestContext, Response> linksHandler() {
@@ -459,6 +461,7 @@ public Response apply(ContainerRequestContext ctx) {
 	}
 
 	/**
+	 * Api method.
 	 * @return response
 	 */
 	public static Inflector<ContainerRequestContext, Response> meHandler() {
@@ -497,6 +500,7 @@ public Response apply(ContainerRequestContext ctx) {
 	}
 
 	/**
+	 * Api method.
 	 * @return response
 	 */
 	public static Inflector<ContainerRequestContext, Response> readIdHandler() {
@@ -513,6 +517,7 @@ public Response apply(ContainerRequestContext ctx) {
 	}
 
 	/**
+	 * Api method.
 	 * @return response
 	 */
 	public static Inflector<ContainerRequestContext, Response> configOptionsHandler() {
@@ -535,6 +540,7 @@ public Response apply(ContainerRequestContext ctx) {
 	}
 
 	/**
+	 * Api method.
 	 * @param a {@link App}
 	 * @return response
 	 */
@@ -556,6 +562,7 @@ public Response apply(ContainerRequestContext ctx) {
 	}
 
 	/**
+	 * Api method.
 	 * @param a {@link App}
 	 * @return response
 	 */
@@ -583,6 +590,7 @@ public Response apply(ContainerRequestContext ctx) {
 	}
 
 	/**
+	 * Api method.
 	 * @param a {@link App}
 	 * @return response
 	 */
@@ -605,6 +613,7 @@ public Response apply(ContainerRequestContext ctx) {
 	}
 
 	/**
+	 * Api method.
 	 * @param a {@link App}
 	 * @return response
 	 */
@@ -626,6 +635,7 @@ public Response apply(ContainerRequestContext ctx) {
 	}
 
 	/**
+	 * Api method.
 	 * @param a {@link App}
 	 * @return response
 	 */
@@ -646,6 +656,7 @@ public Response apply(ContainerRequestContext ctx) {
 	}
 
 	/**
+	 * Api method.
 	 * @param a {@link App}
 	 * @return response
 	 */
@@ -687,6 +698,7 @@ public Response apply(ContainerRequestContext ctx) {
 	}
 
 	/**
+	 * Api method.
 	 * @param a {@link App}
 	 * @return response
 	 */
@@ -714,6 +726,7 @@ public Response apply(ContainerRequestContext ctx) {
 	}
 
 	/**
+	 * Api method.
 	 * @param a {@link App}
 	 * @return response
 	 */
@@ -824,6 +837,7 @@ public Response apply(ContainerRequestContext ctx) {
 	}
 
 	/**
+	 * Api method.
 	 * @param a {@link App}
 	 * @param type a type
 	 * @return response
@@ -838,6 +852,7 @@ public Response apply(ContainerRequestContext ctx) {
 	}
 
 	/**
+	 * Api method.
 	 * @param a {@link App}
 	 * @param type a type
 	 * @return response
@@ -857,6 +872,7 @@ public Response apply(ContainerRequestContext ctx) {
 	}
 
 	/**
+	 * Api method.
 	 * @param a {@link App}
 	 * @param type a type
 	 * @return response
@@ -876,6 +892,7 @@ public Response apply(ContainerRequestContext ctx) {
 	}
 
 	/**
+	 * Api method.
 	 * @param a {@link App}
 	 * @param type a type
 	 * @return response
@@ -891,6 +908,7 @@ public Response apply(ContainerRequestContext ctx) {
 	}
 
 	/**
+	 * Api method.
 	 * @param a {@link App}
 	 * @param type a type
 	 * @return response
@@ -907,6 +925,7 @@ public Response apply(ContainerRequestContext ctx) {
 	}
 
 	/**
+	 * Api method.
 	 * @param a {@link App}
 	 * @return response
 	 */
@@ -920,6 +939,7 @@ public Response apply(ContainerRequestContext ctx) {
 	}
 
 	/**
+	 * Api method.
 	 * @param a {@link App}
 	 * @return response
 	 */
@@ -933,6 +953,7 @@ public Response apply(ContainerRequestContext ctx) {
 	}
 
 	/**
+	 * Api method.
 	 * @param a {@link App}
 	 * @return response
 	 */
@@ -959,6 +980,7 @@ public Response apply(ContainerRequestContext ctx) {
 	}
 
 	/**
+	 * Api method.
 	 * @param a {@link App}
 	 * @return response
 	 */
@@ -972,6 +994,7 @@ public Response apply(ContainerRequestContext ctx) {
 	}
 
 	/**
+	 * Api method.
 	 * @param app {@link App}
 	 * @param type a type
 	 * @return response
@@ -996,6 +1019,7 @@ public Response apply(ContainerRequestContext ctx) {
 	}
 
 	/**
+	 * Api method.
 	 * @return response
 	 */
 	public static Inflector<ContainerRequestContext, Response> reindexHandler() {
@@ -1022,6 +1046,7 @@ public Response apply(ContainerRequestContext ctx) {
 	}
 
 	/**
+	 * Api method.
 	 * @param a {@link App}
 	 * @return response
 	 */
@@ -1067,6 +1092,7 @@ public void write(OutputStream os) throws IOException, WebApplicationException {
 	}
 
 	/**
+	 * Api method.
 	 * @param a {@link App}
 	 * @return response
 	 */