From 146a0fb8b0e90f9196e569152f649baf60d6cc8f Mon Sep 17 00:00:00 2001
From: Joaquín Reñé <jrene@curisit.net>
Date: Tue, 07 Oct 2025 14:52:57 +0000
Subject: [PATCH] #4410 - Comments on classes

---
 securis/src/main/java/net/curisit/securis/db/Settings.java |  105 +++++++++++++++++++++++++++++++++++++---------------
 1 files changed, 74 insertions(+), 31 deletions(-)

diff --git a/securis/src/main/java/net/curisit/securis/db/Settings.java b/securis/src/main/java/net/curisit/securis/db/Settings.java
index 74336e1..ed28e2c 100644
--- a/securis/src/main/java/net/curisit/securis/db/Settings.java
+++ b/securis/src/main/java/net/curisit/securis/db/Settings.java
@@ -1,3 +1,6 @@
+/*
+* Copyright @ 2013 CurisTEC, S.A.S. All Rights Reserved.
+*/
 package net.curisit.securis.db;
 
 import java.io.Serializable;
@@ -20,63 +23,103 @@
 import com.fasterxml.jackson.annotation.JsonProperty;
 
 /**
- * Entity implementation class for Entity: settings settings is a table that has
- * rows with 3 columns: "key", "value", "timestamp"
- *
- */
-@Entity()
-@EntityListeners({
-    ModificationTimestampListener.class
-})
+* Settings
+* <p>
+* Simple key/value store with last modification timestamp.
+* Table rows have columns: "key", "value", "modification_timestamp".
+*
+* Mapping details:
+* - Table: settings
+* - Listeners: {@link ModificationTimestampListener}
+* - NamedQuery: get-param by key
+* 
+* @author JRA
+* Last reviewed by JRA on Oct 5, 2025.
+*/
+@Entity
+@EntityListeners({ ModificationTimestampListener.class })
 @Table(name = "settings")
 @NamedQueries({
     @NamedQuery(name = "get-param", query = "SELECT p FROM Settings p where p.key = :key")
 })
 public class Settings implements ModificationTimestampEntity, Serializable {
+
     @SuppressWarnings("unused")
     private static final Logger LOG = LogManager.getLogger(Settings.class);
 
     private static final long serialVersionUID = 1L;
 
+    /** Primary key: setting key. */
     @Id
     String key;
 
+    /** Setting value as string. */
     String value;
 
+    /** Last modification timestamp. */
     @Column(name = "modification_timestamp")
     @JsonProperty("modification_timestamp")
     private Date modificationTimestamp;
 
-    public String getKey() {
-        return key;
-    }
+    // -------- Getters/setters --------
 
-    public void setKey(String key) {
-        this.key = key;
-    }
+    /** 
+     * getKey<p>
+     * Return setting key. 
+     * 
+     * @return key
+     */
+    public String getKey() { return key; }
 
-    public String getValue() {
-        return value;
-    }
+    /** 
+     * setKey<p>
+     * Set setting key.
+     * 
+     * @param key
+     */
+    public void setKey(String key) { this.key = key; }
 
-    public void setValue(String value) {
-        this.value = value;
-    }
+    /** 
+     * getValue<p>
+     * Return value.
+     * 
+     * @return value
+     */
+    public String getValue() { return value; }
 
+    /** 
+     * setValue<p>
+     * Set value. 
+     * 
+     * @param value
+     */
+    public void setValue(String value) { this.value = value; }
+
+    /** 
+     * getModificationTimestamp<p>
+     * Required by ModificationTimestampEntity. 
+     * 
+     * @return modificationTimestamp
+     */
     @Override
-    public Date getModificationTimestamp() {
-        return modificationTimestamp;
-    }
+    public Date getModificationTimestamp() { return modificationTimestamp; }
 
+    /** 
+     * setModificationTimestamp<p>
+     * Required by ModificationTimestampEntity. 
+     * 
+     * @param modificationTimestamp
+     */
     @Override
-    public void setModificationTimestamp(Date modificationTimestamp) {
-        this.modificationTimestamp = modificationTimestamp;
-    }
+    public void setModificationTimestamp(Date modificationTimestamp) { this.modificationTimestamp = modificationTimestamp; }
 
+    /**
+     * toString<p>
+     * Get the string describing the current object
+     * 
+     * @return object string
+     */
     @Override
-    public String toString() {
-
-        return String.format("{key: %s, value: %s, ts: %s}", key, value, modificationTimestamp);
-    }
-
+    public String toString() { return String.format("{key: %s, value: %s, ts: %s}", key, value, modificationTimestamp); }
 }
+

--
Gitblit v1.3.2