#4410 - Comments on classes

Joaquín Reñé

2025-10-07 146a0fb8b0e90f9196e569152f649baf60d6cc8f

 securis/src/main/java/net/curisit/securis/db/common/Metadata.java
..
..
@@ -1,16 +1,64 @@
1
+/*
2
+* Copyright @ 2013 CurisTEC, S.A.S. All Rights Reserved.
3
+*/
1
4
 package net.curisit.securis.db.common;
2
5
 
6
+/**
7
+* Metadata
8
+* <p>
9
+* Contract for metadata entries (key/value/mandatory).
10
+* Implemented by ApplicationMetadata, LicenseTypeMetadata, PackMetadata, etc.
11
+* 
12
+* @author JRA
13
+* Last reviewed by JRA on Oct 5, 2025.
14
+*/
3
15
 public interface Metadata {
4
-	public String getKey();
16
+	
17
+    /** 
18
+     * getKey<p>
19
+     * Return entry key.
20
+     * 
21
+     * @return key
22
+     */
23
+    String getKey();
24
+    
25
+    /** 
26
+     * setKey<p>
27
+     * Set entry key. 
28
+     * 
29
+     * @param key
30
+     */
31
+    void setKey(String key);
5
32
 
6
-	public void setKey(String key);
33
+    /** 
34
+     * getValue<p>
35
+     * Return entry value. 
36
+     * 
37
+     * @return value
38
+     */
39
+    String getValue();
40
+    
41
+    /** 
42
+     * setValue<p>
43
+     * Set entry value. 
44
+     * 
45
+     * @param value
46
+     */
47
+    void setValue(String value);
7
48
 
8
-	public String getValue();
9
-
10
-	public void setValue(String value);
11
-
12
-	public boolean isMandatory();
13
-
14
-	public void setMandatory(boolean mandatory);
15
-
49
+    /** 
50
+     * isMandatory<p>
51
+     * Whether this metadata is required. 
52
+     * 
53
+     * @return isMandatory
54
+     */
55
+    boolean isMandatory();
56
+    
57
+    /** 
58
+     * setMandatory<p>
59
+     * Set required flag. 
60
+     * 
61
+     * @param mandatory
62
+     */
63
+    void setMandatory(boolean mandatory);
16
64
 }