ONOS-5552 DocumentTree builder not available
Change-Id: Id0e9e0c647146c27e21e2ec2b2014789bbd9eca9
diff --git a/core/api/src/main/java/org/onosproject/store/service/DocumentTreeBuilder.java b/core/api/src/main/java/org/onosproject/store/service/DocumentTreeBuilder.java
new file mode 100644
index 0000000..4b8d011
--- /dev/null
+++ b/core/api/src/main/java/org/onosproject/store/service/DocumentTreeBuilder.java
@@ -0,0 +1,60 @@
+/*
+ * Copyright 2016-present Open Networking Laboratory
+ *
+ * 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 org.onosproject.store.service;
+
+import org.onosproject.store.primitives.DistributedPrimitiveBuilder;
+
+/**
+ * Builder for {@link DocumentTree}.
+ */
+public abstract class DocumentTreeBuilder<V>
+ extends DistributedPrimitiveBuilder<DocumentTreeBuilder<V>, AsyncDocumentTree<V>> {
+
+ private boolean purgeOnUninstall = false;
+
+ public DocumentTreeBuilder() {
+ super(DistributedPrimitive.Type.DOCUMENT_TREE);
+ }
+
+ /**
+ * Clears document tree contents when the owning application is uninstalled.
+ *
+ * @return this builder
+ */
+ public DocumentTreeBuilder<V> withPurgeOnUninstall() {
+ purgeOnUninstall = true;
+ return this;
+ }
+
+ /**
+ * Return if document tree entries need to be cleared when owning application is uninstalled.
+ *
+ * @return true if items are to be cleared on uninstall
+ */
+ public boolean purgeOnUninstall() {
+ return purgeOnUninstall;
+ }
+
+ /**
+ * Builds the distributed Document tree based on the configuration options supplied
+ * to this builder.
+ *
+ * @return new distributed document tree
+ * @throws java.lang.RuntimeException if a mandatory parameter is missing
+ */
+ public abstract AsyncDocumentTree<V> buildDocumentTree();
+}
\ No newline at end of file
diff --git a/core/api/src/main/java/org/onosproject/store/service/StorageService.java b/core/api/src/main/java/org/onosproject/store/service/StorageService.java
index 2e2acfb..21fdfda 100644
--- a/core/api/src/main/java/org/onosproject/store/service/StorageService.java
+++ b/core/api/src/main/java/org/onosproject/store/service/StorageService.java
@@ -44,6 +44,14 @@
<K, V> ConsistentMapBuilder<K, V> consistentMapBuilder();
/**
+ * Creates a new ConsistentMapBuilder.
+ *
+ * @param <V> value type
+ * @return builder for a consistent map
+ */
+ <V> DocumentTreeBuilder<V> documentTreeBuilder();
+
+ /**
* Creates a new {@code AsyncConsistentTreeMapBuilder}.
*
* @param <V> value type
diff --git a/core/api/src/test/java/org/onosproject/store/service/StorageServiceAdapter.java b/core/api/src/test/java/org/onosproject/store/service/StorageServiceAdapter.java
index 01cc065..29dd72d 100644
--- a/core/api/src/test/java/org/onosproject/store/service/StorageServiceAdapter.java
+++ b/core/api/src/test/java/org/onosproject/store/service/StorageServiceAdapter.java
@@ -30,6 +30,11 @@
}
@Override
+ public <V> DocumentTreeBuilder<V> documentTreeBuilder() {
+ return null;
+ }
+
+ @Override
public <E> DistributedSetBuilder<E> setBuilder() {
return null;
}