aboutsummaryrefslogtreecommitdiffhomepage
path: root/third_party/checker_framework_dataflow/java/org/checkerframework/dataflow/analysis/AbstractValue.java
diff options
context:
space:
mode:
Diffstat (limited to 'third_party/checker_framework_dataflow/java/org/checkerframework/dataflow/analysis/AbstractValue.java')
-rw-r--r--third_party/checker_framework_dataflow/java/org/checkerframework/dataflow/analysis/AbstractValue.java27
1 files changed, 27 insertions, 0 deletions
diff --git a/third_party/checker_framework_dataflow/java/org/checkerframework/dataflow/analysis/AbstractValue.java b/third_party/checker_framework_dataflow/java/org/checkerframework/dataflow/analysis/AbstractValue.java
new file mode 100644
index 0000000000..2dbcbd4b03
--- /dev/null
+++ b/third_party/checker_framework_dataflow/java/org/checkerframework/dataflow/analysis/AbstractValue.java
@@ -0,0 +1,27 @@
+package org.checkerframework.dataflow.analysis;
+
+/**
+ * An abstract value used in the org.checkerframework.dataflow analysis.
+ *
+ * @author Stefan Heule
+ *
+ */
+public interface AbstractValue<V extends AbstractValue<V>> {
+
+ /**
+ * Compute the least upper bound of two stores.
+ *
+ * <p>
+ *
+ * <em>Important</em>: This method must fulfill the following contract:
+ * <ul>
+ * <li>Does not change {@code this}.</li>
+ * <li>Does not change {@code other}.</li>
+ * <li>Returns a fresh object which is not aliased yet.</li>
+ * <li>Returns an object of the same (dynamic) type as {@code this}, even if
+ * the signature is more permissive.</li>
+ * <li>Is commutative.</li>
+ * </ul>
+ */
+ V leastUpperBound(V other);
+}