Sithara Punnassery | 112ed82 | 2016-10-24 14:55:19 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2016-present Open Networking Laboratory |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | package org.onosproject.store.service; |
| 18 | |
| 19 | import org.onosproject.store.primitives.DistributedPrimitiveBuilder; |
| 20 | |
| 21 | /** |
| 22 | * Builder for {@link DocumentTree}. |
| 23 | */ |
| 24 | public abstract class DocumentTreeBuilder<V> |
| 25 | extends DistributedPrimitiveBuilder<DocumentTreeBuilder<V>, AsyncDocumentTree<V>> { |
| 26 | |
| 27 | private boolean purgeOnUninstall = false; |
| 28 | |
| 29 | public DocumentTreeBuilder() { |
| 30 | super(DistributedPrimitive.Type.DOCUMENT_TREE); |
| 31 | } |
| 32 | |
| 33 | /** |
| 34 | * Clears document tree contents when the owning application is uninstalled. |
| 35 | * |
| 36 | * @return this builder |
| 37 | */ |
| 38 | public DocumentTreeBuilder<V> withPurgeOnUninstall() { |
| 39 | purgeOnUninstall = true; |
| 40 | return this; |
| 41 | } |
| 42 | |
| 43 | /** |
| 44 | * Return if document tree entries need to be cleared when owning application is uninstalled. |
| 45 | * |
| 46 | * @return true if items are to be cleared on uninstall |
| 47 | */ |
| 48 | public boolean purgeOnUninstall() { |
| 49 | return purgeOnUninstall; |
| 50 | } |
| 51 | |
| 52 | /** |
| 53 | * Builds the distributed Document tree based on the configuration options supplied |
| 54 | * to this builder. |
| 55 | * |
| 56 | * @return new distributed document tree |
| 57 | * @throws java.lang.RuntimeException if a mandatory parameter is missing |
| 58 | */ |
| 59 | public abstract AsyncDocumentTree<V> buildDocumentTree(); |
| 60 | } |