reactify-core docs

Author: hoangtien2k3

pom.xml

@@ -49,7 +49,7 @@
     </distributionManagement>
 
     <properties>
-        <reactify.version>1.1.4</reactify.version>
+        <reactify.version>1.1.5</reactify.version>
         <java.version>21</java.version>
         <micrometer.tracing.version>1.3.1</micrometer.tracing.version>
         <micrometer.registry.version>1.13.1</micrometer.registry.version>

reactify/src/main/java/io/hoangtien2k3/reactify/SpringCommonsApplication.java

@@ -24,6 +24,11 @@
 import org.springframework.context.annotation.ComponentScan;
 import org.springframework.context.annotation.ImportResource;
 
+/**
+ * <p>SpringCommonsApplication class.</p>
+ *
+ * @author hoangtien2k3
+ */
 @SpringBootApplication(
         exclude = {
             DataSourceAutoConfiguration.class,
@@ -36,6 +41,11 @@
 // @EnableDiscoveryClient
 public class SpringCommonsApplication {
 
+    /**
+     * <p>main.</p>
+     *
+     * @param args an array of {@link java.lang.String} objects
+     */
     public static void main(String[] args) {
         SpringApplication.run(SpringCommonsApplication.class, args);
     }

reactify/src/main/java/io/hoangtien2k3/reactify/annotations/LocalCache.java

@@ -21,6 +21,11 @@
 import java.lang.annotation.Target;
 
 /** @deprecated */
+/**
+ * <p>LocalCache class.</p>
+ *
+ * @author hoangtien2k3
+ */
 @Deprecated
 @Target(ElementType.METHOD)
 @Retention(RetentionPolicy.RUNTIME)

reactify/src/main/java/io/hoangtien2k3/reactify/annotations/LogPerformance.java

@@ -20,6 +20,11 @@
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+/**
+ * <p>LogPerformance class.</p>
+ *
+ * @author hoangtien2k3
+ */
 @Target({ElementType.METHOD, ElementType.TYPE})
 @Retention(RetentionPolicy.RUNTIME)
 public @interface LogPerformance {

reactify/src/main/java/io/hoangtien2k3/reactify/annotations/Loggable.java

@@ -21,6 +21,8 @@
 import java.lang.annotation.Target;
 
 /**
+ * <p>Loggable class.</p>
+ *
  * @author hoangtien2k3
  */
 @Retention(RetentionPolicy.RUNTIME)

reactify/src/main/java/io/hoangtien2k3/reactify/annotations/cache/CacheAspect.java

@@ -30,6 +30,11 @@
 import reactor.core.publisher.Signal;
 
 /** @deprecated */
+/**
+ * <p>CacheAspect class.</p>
+ *
+ * @author hoangtien2k3
+ */
 @Deprecated
 @Aspect
 @Configuration
@@ -38,6 +43,13 @@ public class CacheAspect {
     @Pointcut("@annotation(io.hoangtien2k3.reactify.annotations.LocalCache)")
     private void processAnnotation() {}
 
+    /**
+     * <p>aroundAdvice.</p>
+     *
+     * @param joinPoint a {@link org.aspectj.lang.ProceedingJoinPoint} object
+     * @return a {@link java.lang.Object} object
+     * @throws java.lang.Throwable if any.
+     */
     @Around("processAnnotation()")
     public Object aroundAdvice(ProceedingJoinPoint joinPoint) throws Throwable {
         Object[] args = joinPoint.getArgs();

reactify/src/main/java/io/hoangtien2k3/reactify/annotations/cache/CacheStore.java

@@ -34,6 +34,11 @@
 import org.springframework.stereotype.Component;
 
 /** @deprecated */
+/**
+ * <p>CacheStore class.</p>
+ *
+ * @author hoangtien2k3
+ */
 @Deprecated
 @Slf4j
 @Component
@@ -81,10 +86,21 @@ private static void init() {
         log.info("Finish initializing {} cache", caches.size());
     }
 
+    /**
+     * <p>getCache.</p>
+     *
+     * @param key a {@link java.lang.String} object
+     * @return a {@link com.github.benmanes.caffeine.cache.Cache} object
+     */
     public static Cache getCache(String key) {
         return caches.get(key);
     }
 
+    /**
+     * <p>autoLoad.</p>
+     *
+     * @param event a {@link org.springframework.context.event.ContextRefreshedEvent} object
+     */
     @Async
     @EventListener
     public void autoLoad(ContextRefreshedEvent event) {

reactify/src/main/java/io/hoangtien2k3/reactify/annotations/cache/CacheUtils.java

@@ -23,12 +23,22 @@
 import reactor.core.publisher.Mono;
 
 /** @deprecated */
+/**
+ * <p>CacheUtils class.</p>
+ *
+ * @author hoangtien2k3
+ */
 @Deprecated
 @Slf4j
 @Component
 @RequiredArgsConstructor
 public class CacheUtils {
 
+    /**
+     * <p>invokeMethod.</p>
+     *
+     * @param method a {@link java.lang.reflect.Method} object
+     */
     public static void invokeMethod(Method method) {
         try {
             Class declaringClass = method.getDeclaringClass();

reactify/src/main/java/io/hoangtien2k3/reactify/annotations/cache/CustomizeRemovalListener.java

@@ -24,12 +24,18 @@
 import org.checkerframework.checker.nullness.qual.Nullable;
 
 /** @deprecated */
+/**
+ * <p>CustomizeRemovalListener class.</p>
+ *
+ * @author hoangtien2k3
+ */
 @Deprecated
 @Slf4j
 @AllArgsConstructor
 public class CustomizeRemovalListener implements RemovalListener {
     private Method method;
 
+    /** {@inheritDoc} */
     @Override
     public void onRemoval(@Nullable Object key, @Nullable Object value, @NonNull RemovalCause removalCause) {
         if (removalCause.wasEvicted()) {

reactify/src/main/java/io/hoangtien2k3/reactify/annotations/logging/LoggerAspect.java

@@ -22,12 +22,20 @@
 import org.aspectj.lang.annotation.Pointcut;
 import org.springframework.context.annotation.Configuration;
 
+/**
+ * <p>LoggerAspect class.</p>
+ *
+ * @author hoangtien2k3
+ */
 @Aspect
 @Configuration
 @RequiredArgsConstructor
 public class LoggerAspect {
     private final LoggerAspectUtils loggerAspectUtils;
 
+    /**
+     * <p>performancePointCut.</p>
+     */
     @Pointcut("(execution(* io.hoangtien2k3.reactify.*.controller..*(..)) || "
             + "execution(* io.hoangtien2k3.reactify.*.service..*(..))  ||  "
             + "execution(* io.hoangtien2k3.reactify.*.repository..*(..)) || "
@@ -38,6 +46,13 @@ public void performancePointCut() {}
     @Pointcut("@annotation(io.hoangtien2k3.reactify.annotations.LogPerformance)")
     private void logPerfMethods() {}
 
+    /**
+     * <p>logAround.</p>
+     *
+     * @param joinPoint a {@link org.aspectj.lang.ProceedingJoinPoint} object
+     * @return a {@link java.lang.Object} object
+     * @throws java.lang.Throwable if any.
+     */
     @Around("performancePointCut() || logPerfMethods()")
     public Object logAround(ProceedingJoinPoint joinPoint) throws Throwable {
         return loggerAspectUtils.logAround(joinPoint);