Madan Jampani | 619453b | 2015-07-22 23:47:09 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2015 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 | */ |
Madan Jampani | f1b8e17 | 2015-03-23 11:42:02 -0700 | [diff] [blame] | 16 | package org.onosproject.store.service; |
| 17 | |
Madan Jampani | 538be74 | 2016-02-10 14:55:38 -0800 | [diff] [blame] | 18 | import org.onosproject.store.primitives.DistributedPrimitiveBuilder; |
Madan Jampani | f1b8e17 | 2015-03-23 11:42:02 -0700 | [diff] [blame] | 19 | |
| 20 | /** |
Madan Jampani | dfde6ba | 2016-01-13 21:36:09 -0800 | [diff] [blame] | 21 | * Builder for {@link ConsistentMap} instances. |
Madan Jampani | f1b8e17 | 2015-03-23 11:42:02 -0700 | [diff] [blame] | 22 | * |
| 23 | * @param <K> type for map key |
| 24 | * @param <V> type for map value |
| 25 | */ |
Madan Jampani | 538be74 | 2016-02-10 14:55:38 -0800 | [diff] [blame] | 26 | public abstract class ConsistentMapBuilder<K, V> |
| 27 | extends DistributedPrimitiveBuilder<ConsistentMapBuilder<K, V>, ConsistentMap<K, V>> { |
| 28 | |
| 29 | private boolean purgeOnUninstall = false; |
| 30 | |
| 31 | public ConsistentMapBuilder() { |
| 32 | super(DistributedPrimitive.Type.CONSISTENT_MAP); |
| 33 | } |
Madan Jampani | f1b8e17 | 2015-03-23 11:42:02 -0700 | [diff] [blame] | 34 | |
| 35 | /** |
Madan Jampani | 538be74 | 2016-02-10 14:55:38 -0800 | [diff] [blame] | 36 | * Clears map contents when the owning application is uninstalled. |
Madan Jampani | f1b8e17 | 2015-03-23 11:42:02 -0700 | [diff] [blame] | 37 | * |
Madan Jampani | 538be74 | 2016-02-10 14:55:38 -0800 | [diff] [blame] | 38 | * return this builder |
Madan Jampani | f1b8e17 | 2015-03-23 11:42:02 -0700 | [diff] [blame] | 39 | */ |
Madan Jampani | 538be74 | 2016-02-10 14:55:38 -0800 | [diff] [blame] | 40 | public ConsistentMapBuilder<K, V> withPurgeOnUninstall() { |
| 41 | purgeOnUninstall = true; |
| 42 | return this; |
| 43 | } |
Madan Jampani | f1b8e17 | 2015-03-23 11:42:02 -0700 | [diff] [blame] | 44 | |
| 45 | /** |
Madan Jampani | 538be74 | 2016-02-10 14:55:38 -0800 | [diff] [blame] | 46 | * Returns if map entries need to be cleared when owning application is uninstalled. |
| 47 | * @return {@code true} if yes; {@code false} otherwise. |
Madan Jampani | e8af1cc | 2015-06-23 14:23:31 -0700 | [diff] [blame] | 48 | */ |
Madan Jampani | 538be74 | 2016-02-10 14:55:38 -0800 | [diff] [blame] | 49 | public boolean purgeOnUninstall() { |
| 50 | return purgeOnUninstall; |
| 51 | } |
Madan Jampani | f1b8e17 | 2015-03-23 11:42:02 -0700 | [diff] [blame] | 52 | |
| 53 | /** |
| 54 | * Builds an async consistent map based on the configuration options |
| 55 | * supplied to this builder. |
| 56 | * |
| 57 | * @return new async consistent map |
| 58 | * @throws java.lang.RuntimeException if a mandatory parameter is missing |
| 59 | */ |
Madan Jampani | 538be74 | 2016-02-10 14:55:38 -0800 | [diff] [blame] | 60 | public abstract AsyncConsistentMap<K, V> buildAsyncMap(); |
Sho SHIMIZU | 3310a34 | 2015-05-13 12:14:05 -0700 | [diff] [blame] | 61 | } |