aboutsummaryrefslogtreecommitdiffstats
path: root/libraries/spongycastle/core/src/main/java/org/spongycastle/util/Memoable.java
diff options
context:
space:
mode:
Diffstat (limited to 'libraries/spongycastle/core/src/main/java/org/spongycastle/util/Memoable.java')
-rw-r--r--libraries/spongycastle/core/src/main/java/org/spongycastle/util/Memoable.java23
1 files changed, 23 insertions, 0 deletions
diff --git a/libraries/spongycastle/core/src/main/java/org/spongycastle/util/Memoable.java b/libraries/spongycastle/core/src/main/java/org/spongycastle/util/Memoable.java
new file mode 100644
index 000000000..75280e5a2
--- /dev/null
+++ b/libraries/spongycastle/core/src/main/java/org/spongycastle/util/Memoable.java
@@ -0,0 +1,23 @@
+package org.spongycastle.util;
+
+public interface Memoable
+{
+ /**
+ * Produce a copy of this object with its configuration and in its current state.
+ * <p/>
+ * The returned object may be used simply to store the state, or may be used as a similar object
+ * starting from the copied state.
+ */
+ public Memoable copy();
+
+ /**
+ * Restore a copied object state into this object.
+ * <p/>
+ * Implementations of this method <em>should</em> try to avoid or minimise memory allocation to perform the reset.
+ *
+ * @param other an object originally {@link #copy() copied} from an object of the same type as this instance.
+ * @throws ClassCastException if the provided object is not of the correct type.
+ * @throws MemoableResetException if the <b>other</b> parameter is in some other way invalid.
+ */
+ public void reset(Memoable other);
+}