Sithara Punnassery | 112ed82 | 2016-10-24 14:55:19 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2016-present Open Networking Foundation |
Sithara Punnassery | 112ed82 | 2016-10-24 14:55:19 -0700 | [diff] [blame] | 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; |
Jordan Halterman | d0d8035 | 2017-08-10 15:08:27 -0700 | [diff] [blame] | 28 | private Ordering ordering = Ordering.NATURAL; |
Sithara Punnassery | 112ed82 | 2016-10-24 14:55:19 -0700 | [diff] [blame] | 29 | |
| 30 | public DocumentTreeBuilder() { |
| 31 | super(DistributedPrimitive.Type.DOCUMENT_TREE); |
| 32 | } |
| 33 | |
| 34 | /** |
| 35 | * Clears document tree contents when the owning application is uninstalled. |
| 36 | * |
| 37 | * @return this builder |
| 38 | */ |
| 39 | public DocumentTreeBuilder<V> withPurgeOnUninstall() { |
| 40 | purgeOnUninstall = true; |
| 41 | return this; |
| 42 | } |
| 43 | |
| 44 | /** |
| 45 | * Return if document tree entries need to be cleared when owning application is uninstalled. |
| 46 | * |
| 47 | * @return true if items are to be cleared on uninstall |
| 48 | */ |
| 49 | public boolean purgeOnUninstall() { |
| 50 | return purgeOnUninstall; |
| 51 | } |
| 52 | |
| 53 | /** |
Jordan Halterman | d0d8035 | 2017-08-10 15:08:27 -0700 | [diff] [blame] | 54 | * Sets the ordering of the tree nodes. |
| 55 | * <p> |
| 56 | * When {@link AsyncDocumentTree#getChildren(DocumentPath)} is called, children will be returned according to |
| 57 | * the specified sort order. |
| 58 | * |
| 59 | * @param ordering ordering of the tree nodes |
| 60 | * @return this builder |
| 61 | */ |
| 62 | public DocumentTreeBuilder<V> withOrdering(Ordering ordering) { |
| 63 | this.ordering = ordering; |
| 64 | return this; |
| 65 | } |
| 66 | |
| 67 | /** |
| 68 | * Returns the ordering of tree nodes. |
| 69 | * <p> |
| 70 | * When {@link AsyncDocumentTree#getChildren(DocumentPath)} is called, children will be returned according to |
| 71 | * the specified sort order. |
| 72 | * |
| 73 | * @return the ordering of tree nodes |
| 74 | */ |
| 75 | public Ordering ordering() { |
| 76 | return ordering; |
| 77 | } |
| 78 | |
| 79 | /** |
Sithara Punnassery | 112ed82 | 2016-10-24 14:55:19 -0700 | [diff] [blame] | 80 | * Builds the distributed Document tree based on the configuration options supplied |
| 81 | * to this builder. |
| 82 | * |
| 83 | * @return new distributed document tree |
| 84 | * @throws java.lang.RuntimeException if a mandatory parameter is missing |
| 85 | */ |
| 86 | public abstract AsyncDocumentTree<V> buildDocumentTree(); |
| 87 | } |