From f06c39ddf2954e72ddb64489772b662440e2193d Mon Sep 17 00:00:00 2001
From: Kai Reinhard <K.Reinhard@micromata.de>
Date: Sat, 29 Dec 2018 22:25:45 +0000
Subject: [PATCH] Doc
---
borgbutler-core/src/main/java/de/micromata/borgbutler/cache/ButlerCache.java | 7 +++++++
1 files changed, 7 insertions(+), 0 deletions(-)
diff --git a/borgbutler-core/src/main/java/de/micromata/borgbutler/cache/ButlerCache.java b/borgbutler-core/src/main/java/de/micromata/borgbutler/cache/ButlerCache.java
index 4dceafd..650d4a5 100644
--- a/borgbutler-core/src/main/java/de/micromata/borgbutler/cache/ButlerCache.java
+++ b/borgbutler-core/src/main/java/de/micromata/borgbutler/cache/ButlerCache.java
@@ -20,6 +20,13 @@
import java.util.ArrayList;
import java.util.List;
+/**
+ * Caches all borg objects such as repository information, archive and archive content. Therefore a fluent work
+ * is possible. Without caching, working with BorgButler especially for remote backups would be a time consuming mess.
+ * <br>
+ * For most objects JCS is used. For file lists (up to million of files) an own implementation is used because JCS
+ * isn't recommended for caching a very large number of objects or very large objects.
+ */
public class ButlerCache {
private Logger log = LoggerFactory.getLogger(ButlerCache.class);
public static final String CACHE_DIR_NAME = "cache";
--
Gitblit v1.10.0