Fix CacheStore errors from checkstyle plugin 107 left

VictorZZZZ · VictorZZZZ · commit c150e5f38b23 · 2021-08-22T11:12:53.000+03:00
diff --git a/caching/src/main/java/com/iluwatar/caching/CacheStore.java b/caching/src/main/java/com/iluwatar/caching/CacheStore.java
@@ -35,20 +35,34 @@
  */
 @Slf4j
 public class CacheStore {
+  /**
+   * Cach capacity.
+   */
   private static final int CAPACITY = 3;
 
+  /**
+   * Lru cache see {@link LruCache}.
+   */
   private static LruCache cache;
+  /**
+   * DbManager.
+   */
   private DbManager dbManager;
 
-  public CacheStore(DbManager dbManager) {
-    this.dbManager = dbManager;
+  /**
+   * Cache Store.
+   * @param dataBaseManager {@link DbManager}
+   */
+  public CacheStore(final DbManager dataBaseManager) {
+    this.dbManager = dataBaseManager;
     initCapacity(CAPACITY);
   }
 
   /**
    * Init cache capacity.
+   * @param capacity int
    */
-  public void initCapacity(int capacity) {
+  public void initCapacity(final int capacity) {
     if (cache == null) {
       cache = new LruCache(capacity);
     } else {
@@ -58,8 +72,10 @@ public void initCapacity(int capacity) {
 
   /**
    * Get user account using read-through cache.
+   * @param userId {@link String}
+   * @return {@link UserAccount}
    */
-  public UserAccount readThrough(String userId) {
+  public UserAccount readThrough(final String userId) {
     if (cache.contains(userId)) {
       LOGGER.info("# Found in Cache!");
       return cache.get(userId);
@@ -72,8 +88,9 @@ public UserAccount readThrough(String userId) {
 
   /**
    * Get user account using write-through cache.
+   * @param userAccount {@link UserAccount}
    */
-  public void writeThrough(UserAccount userAccount) {
+  public void writeThrough(final UserAccount userAccount) {
     if (cache.contains(userAccount.getUserId())) {
       dbManager.updateDb(userAccount);
     } else {
@@ -84,11 +101,13 @@ public void writeThrough(UserAccount userAccount) {
 
   /**
    * Get user account using write-around cache.
+   * @param userAccount {@link UserAccount}
    */
-  public void writeAround(UserAccount userAccount) {
+  public void writeAround(final UserAccount userAccount) {
     if (cache.contains(userAccount.getUserId())) {
       dbManager.updateDb(userAccount);
-      cache.invalidate(userAccount.getUserId()); // Cache data has been updated -- remove older
+      // Cache data has been updated -- remove older
+      cache.invalidate(userAccount.getUserId());
       // version from cache.
     } else {
       dbManager.writeToDb(userAccount);
@@ -97,8 +116,10 @@ public void writeAround(UserAccount userAccount) {
 
   /**
    * Get user account using read-through cache with write-back policy.
+   * @param userId {@link String}
+   * @return {@link UserAccount}
    */
-  public UserAccount readThroughWithWriteBackPolicy(String userId) {
+  public UserAccount readThroughWithWriteBackPolicy(final String userId) {
     if (cache.contains(userId)) {
       LOGGER.info("# Found in cache!");
       return cache.get(userId);
@@ -116,8 +137,9 @@ public UserAccount readThroughWithWriteBackPolicy(String userId) {
 
   /**
    * Set user account.
+   * @param userAccount {@link UserAccount}
    */
-  public void writeBehind(UserAccount userAccount) {
+  public void writeBehind(final UserAccount userAccount) {
     if (cache.isFull() && !cache.contains(userAccount.getUserId())) {
       LOGGER.info("# Cache is FULL! Writing LRU data to DB...");
       UserAccount toBeWrittenToDb = cache.getLruData();
@@ -148,6 +170,7 @@ public void flushCache() {
 
   /**
    * Print user accounts.
+   * @return {@link String}
    */
   public String print() {
     return Optional.ofNullable(cache)
@@ -160,22 +183,27 @@ public String print() {
 
   /**
    * Delegate to backing cache store.
+   * @param userId {@link String}
+   * @return {@link UserAccount}
    */
-  public UserAccount get(String userId) {
+  public UserAccount get(final String userId) {
     return cache.get(userId);
   }
 
   /**
    * Delegate to backing cache store.
+   * @param userId {@link String}
+   * @param userAccount {@link UserAccount}
    */
-  public void set(String userId, UserAccount userAccount) {
+  public void set(final String userId, final UserAccount userAccount) {
     cache.set(userId, userAccount);
   }
 
   /**
    * Delegate to backing cache store.
+   * @param userId {@link String}
    */
-  public void invalidate(String userId) {
+  public void invalidate(final String userId) {
     cache.invalidate(userId);
   }
 }
