summaryrefslogtreecommitdiffstats
path: root/infra/data-api/src/main/java/io/fd/honeycomb/data/DataModification.java
diff options
context:
space:
mode:
authorMaros Marsalek <mmarsale@cisco.com>2016-07-29 16:27:12 +0200
committerMaros Marsalek <mmarsale@cisco.com>2016-07-29 16:32:17 +0200
commite3c31cee916480b2d9d169c1f5afb1c42efaabe1 (patch)
treec88b0ca3e7296dd7e68628db6d5f33ffd1e1b55e /infra/data-api/src/main/java/io/fd/honeycomb/data/DataModification.java
parent0578156b721fa01c8c645b8f9625ecebdb6449e4 (diff)
HONEYCOMB-130: Rename infra packages(remove vpp/v3po)
Change-Id: Ic5b90e397e3743623d01b206bc60bc5c7df6b981 Signed-off-by: Maros Marsalek <mmarsale@cisco.com>
Diffstat (limited to 'infra/data-api/src/main/java/io/fd/honeycomb/data/DataModification.java')
-rw-r--r--infra/data-api/src/main/java/io/fd/honeycomb/data/DataModification.java70
1 files changed, 70 insertions, 0 deletions
diff --git a/infra/data-api/src/main/java/io/fd/honeycomb/data/DataModification.java b/infra/data-api/src/main/java/io/fd/honeycomb/data/DataModification.java
new file mode 100644
index 000000000..6e903a4e2
--- /dev/null
+++ b/infra/data-api/src/main/java/io/fd/honeycomb/data/DataModification.java
@@ -0,0 +1,70 @@
+/*
+ * Copyright (c) 2016 Cisco and/or its affiliates.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.fd.honeycomb.data;
+
+import com.google.common.annotations.Beta;
+import io.fd.honeycomb.translate.TranslationException;
+import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
+import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
+import org.opendaylight.yangtools.yang.data.api.schema.tree.DataValidationFailedException;
+
+/**
+ * Modification of a {@link ModifiableDataManager}.
+ */
+@Beta
+public interface DataModification extends ReadableDataManager {
+
+ /**
+ * Delete the node at specified path.
+ *
+ * @param path Node path
+ */
+ void delete(YangInstanceIdentifier path);
+
+ /**
+ * Merge the specified data with the currently-present data
+ * at specified path.
+ *
+ * @param path Node path
+ * @param data Data to be merged
+ */
+ void merge(YangInstanceIdentifier path, NormalizedNode<?, ?> data);
+
+ /**
+ * Replace the data at specified path with supplied data.
+ *
+ * @param path Node path
+ * @param data New node data
+ */
+ void write(YangInstanceIdentifier path, NormalizedNode<?, ?> data);
+
+ /**
+ * Alters data tree using this modification.
+ *
+ * @throws DataValidationFailedException if modification data is not valid
+ * @throws TranslationException if failed while updating data tree state
+ */
+ void commit() throws DataValidationFailedException, TranslationException;
+
+ /**
+ * Validate and prepare modification before commit. Besides commit, no further operation is expected after validate
+ * and the behaviour is undefined.
+ *
+ * @throws DataValidationFailedException if modification data is not valid
+ */
+ void validate() throws DataValidationFailedException;
+}