Aaron Kruglikov | 92511f2 | 2015-10-12 14:39:04 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2015-present Open Networking Foundation |
Aaron Kruglikov | 92511f2 | 2015-10-12 14:39:04 -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.persistence; |
| 18 | |
| 19 | import org.onosproject.store.service.Serializer; |
| 20 | |
| 21 | import java.util.Set; |
| 22 | |
| 23 | /** |
| 24 | * The default interface for the persistent set builder for use with mapDB. |
| 25 | */ |
| 26 | public interface PersistentSetBuilder<E> { |
| 27 | |
| 28 | /** |
| 29 | * Sets the name of this set. |
| 30 | * @param name the string name of this set |
| 31 | * @return a persistent set builder with the name option now set |
| 32 | */ |
| 33 | PersistentSetBuilder<E> withName(String name); |
| 34 | |
| 35 | /** |
| 36 | * Sets the serializer to be used to serialize this set, this is a required parameter. |
| 37 | * @param serializer the serializer to be used |
| 38 | * @return a persistent set builder with the serializer set |
| 39 | */ |
| 40 | PersistentSetBuilder<E> withSerializer(Serializer serializer); |
| 41 | |
| 42 | /** |
| 43 | * Validates the set settings and then builds this map in the database. Throws an exception if invalid settings |
| 44 | * are found. |
| 45 | * @return The set that was created |
| 46 | */ |
| 47 | Set<E> build(); |
| 48 | } |