Add CommitInfo and return it from transactions

[mdsal.git] / common / mdsal-common-api / src / main / java / org / opendaylight / mdsal / common / api / CommitInfo.java

diff --git a/common/mdsal-common-api/src/main/java/org/opendaylight/mdsal/common/api/CommitInfo.java b/common/mdsal-common-api/src/main/java/org/opendaylight/mdsal/common/api/CommitInfo.java
new file mode 100644 (file)
index 0000000..e4965fd
--- /dev/null
+++ b/common/mdsal-common-api/src/main/java/org/opendaylight/mdsal/common/api/CommitInfo.java
@@ -0,0 +1,41 @@
+/*
+ * Copyright (c) 2018 Pantheon Technologies, s.r.o. and others.  All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.opendaylight.mdsal.common.api;
+
+import com.google.common.annotations.Beta;
+import com.google.common.util.concurrent.FluentFuture;
+import org.eclipse.jdt.annotation.NonNullByDefault;
+
+/**
+ * Base interface for tagging information about a successful commit. This can include various ways of identifying
+ * the resulting changeset, timing information or any other piece of data about the commit itself the implementation
+ * deems interesting to the client.
+ *
+ * @author Robert Varga
+ */
+@Beta
+@NonNullByDefault
+public interface CommitInfo {
+    /**
+     * Return an empty {@link CommitInfo}.
+     *
+     * @return An empty {@link CommitInfo} instance.
+     */
+    static CommitInfo empty() {
+        return EmptyCommitInfo.INSTANCE;
+    }
+
+    /**
+     * Return an immediately-completed empty {@link CommitInfo} future.
+     *
+     * @return An empty {@link CommitInfo} instance enclosed in a completed future.
+     */
+    static FluentFuture<CommitInfo> emptyFluentFuture() {
+        return EmptyCommitInfo.FLUENT_INSTANCE;
+    }
+}