You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,7 +34,7 @@ After which it provides all the features of cache seamlessly.<br>
34
34
35
35
The features provided by the library are,
36
36
* Easy Implementation<br>
37
-
To implement the cache the user has to implement only two interfaces (i.e [CacheDB]() and [PersistentDB]()).
37
+
To implement the cache the user has to implement only two interfaces (i.e <b>CacheDB</b> and <b>PersistentDB</b>).
38
38
These databases can be of any type.(Relational or Non-Relational database) and rest is taken care by the SimplCache.
39
39
* Least Recently Used (LRU) Eviction<br>
40
40
Least recently used cache object is evicted when cache reaches maximum limit.
@@ -72,7 +72,7 @@ dependencies {
72
72
<td><b>IMPORTANT</b></td>
73
73
<td>To set the cache size in terms of object memory VM options have to be enabled while executing the main class of your project.<br>
74
74
<ul>
75
-
<li>Download the <ahref="">JAR</a><br></li>
75
+
<li>Download the <ahref="https://mvnrepository.com/artifact/com.github.lekhana3003/SimplCache">JAR</a><br></li>
76
76
<li>Execute java function by enabling VM options as: java -javaagent:"path to downloaded jar"<br>
77
77
Ex:java -javaagent:"../SimplCache.jar"</li>
78
78
</ul>
@@ -89,7 +89,7 @@ For Reference:<br>
89
89
90
90
### 3.1 Getting Started
91
91
To implement cache using the library, it requires some methods to be implemented which are present in the interfaces
92
-
[CacheDB]() and [PersistentDB](). The SimplCache object is built using the SimplCache Builder.
92
+
<b>CacheDB</b> and <b>PersistentDB</b>. The SimplCache object is built using the SimplCache Builder.
93
93
The Constructor of the builder takes two objects of CacheDB and PersistentDB.The model of the object that has to be stored in the cache has to be provided while implementing the interfaces.<br>
94
94
Example:<br>
95
95
The object to be stored in the cache is Car Model.<br>
@@ -244,7 +244,7 @@ This parameter given by the user decides if the modified objects should be writt
244
244
245
245
##### Saving:
246
246
This method is used to save the state of cache at any given time. This method returns a string which is encrypted with default encryption algorithm.
247
-
If the user wants to implement any other encryption mechanism, the user is required to pass an object of classwhich has implemented [SimplCacheEncryptor](). The cache objects are written back into persistent database before saving the state,
247
+
If the user wants to implement any other encryption mechanism, the user is required to pass an object of classwhich has implemented <b>SimplCacheEncryptor</b>. The cache objects are written back into persistent database before saving the state,
248
248
This method returns only the keys of cache object and also stores the properties which are set for the cache in the SimplCache object. It does not store the entire object which is stored in the cache.
249
249
The two variations as follows,<br>
250
250
* With default encryptor,
@@ -265,7 +265,7 @@ The two variations as follows,<br>
265
265
##### Building from save state:
266
266
This method is used to build back the cache from the string which is returned by the <b>saveState()</b> method.
267
267
This method restores cache objects from persistent database.
268
-
This method takes cacheDB and persistenseDB implemented objects again along with optional [SimplCacheEncryptor]() object.
268
+
This method takes cacheDB and persistenseDB implemented objects again along with optional <b>SimplCacheEncryptor</b> object.
0 commit comments