Sho SHIMIZU | b85000d | 2016-05-17 14:00:05 -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 | package org.onosproject.store.resource.impl; |
| 17 | |
Sho SHIMIZU | b85000d | 2016-05-17 14:00:05 -0700 | [diff] [blame] | 18 | import org.onosproject.net.resource.DiscreteResource; |
| 19 | import org.onosproject.net.resource.DiscreteResourceId; |
Sho SHIMIZU | b85000d | 2016-05-17 14:00:05 -0700 | [diff] [blame] | 20 | |
Sho SHIMIZU | b85000d | 2016-05-17 14:00:05 -0700 | [diff] [blame] | 21 | import java.util.List; |
Sho SHIMIZU | b85000d | 2016-05-17 14:00:05 -0700 | [diff] [blame] | 22 | import java.util.Optional; |
| 23 | import java.util.Set; |
| 24 | |
Sho SHIMIZU | 94e8a16 | 2016-05-19 17:09:59 -0700 | [diff] [blame^] | 25 | /** |
| 26 | * A common API for a set of discrete resources. |
| 27 | */ |
Sho SHIMIZU | 32f57e9 | 2016-05-18 10:23:06 -0700 | [diff] [blame] | 28 | interface DiscreteResources { |
Sho SHIMIZU | 94e8a16 | 2016-05-19 17:09:59 -0700 | [diff] [blame^] | 29 | /** |
| 30 | * Returns an instance representing an empty set. |
| 31 | * |
| 32 | * @return a empty set. |
| 33 | */ |
Sho SHIMIZU | b85000d | 2016-05-17 14:00:05 -0700 | [diff] [blame] | 34 | static DiscreteResources empty() { |
Sho SHIMIZU | 32f57e9 | 2016-05-18 10:23:06 -0700 | [diff] [blame] | 35 | return NonEncodableDiscreteResources.empty(); |
Sho SHIMIZU | b85000d | 2016-05-17 14:00:05 -0700 | [diff] [blame] | 36 | } |
| 37 | |
Sho SHIMIZU | 94e8a16 | 2016-05-19 17:09:59 -0700 | [diff] [blame^] | 38 | /** |
| 39 | * Look up a discrete resource instance by ID. |
| 40 | * |
| 41 | * @param id id |
| 42 | * @return found instance enclosed by Optional |
| 43 | */ |
Sho SHIMIZU | 32f57e9 | 2016-05-18 10:23:06 -0700 | [diff] [blame] | 44 | Optional<DiscreteResource> lookup(DiscreteResourceId id); |
Sho SHIMIZU | b85000d | 2016-05-17 14:00:05 -0700 | [diff] [blame] | 45 | |
Sho SHIMIZU | 94e8a16 | 2016-05-19 17:09:59 -0700 | [diff] [blame^] | 46 | /** |
| 47 | * Returns a difference set of this instance and the given instance. |
| 48 | * |
| 49 | * @param other other instance |
| 50 | * @return a new DiscreteResources instance representing a difference set |
| 51 | */ |
Sho SHIMIZU | 32f57e9 | 2016-05-18 10:23:06 -0700 | [diff] [blame] | 52 | DiscreteResources difference(DiscreteResources other); |
Sho SHIMIZU | b85000d | 2016-05-17 14:00:05 -0700 | [diff] [blame] | 53 | |
Sho SHIMIZU | 94e8a16 | 2016-05-19 17:09:59 -0700 | [diff] [blame^] | 54 | /** |
| 55 | * Checks that this instance is empty. |
| 56 | * |
| 57 | * @return true if this instance is empty, otherwise false. |
| 58 | */ |
Sho SHIMIZU | 32f57e9 | 2016-05-18 10:23:06 -0700 | [diff] [blame] | 59 | boolean isEmpty(); |
Sho SHIMIZU | b85000d | 2016-05-17 14:00:05 -0700 | [diff] [blame] | 60 | |
Sho SHIMIZU | 94e8a16 | 2016-05-19 17:09:59 -0700 | [diff] [blame^] | 61 | /** |
| 62 | * Checks that this instance contains any of the given resources. |
| 63 | * |
| 64 | * @param other resources |
| 65 | * @return true this instance contains a resource included in the given resources, |
| 66 | * otherwise false. |
| 67 | */ |
Sho SHIMIZU | 32f57e9 | 2016-05-18 10:23:06 -0700 | [diff] [blame] | 68 | boolean containsAny(List<DiscreteResource> other); |
Sho SHIMIZU | b85000d | 2016-05-17 14:00:05 -0700 | [diff] [blame] | 69 | |
Sho SHIMIZU | 94e8a16 | 2016-05-19 17:09:59 -0700 | [diff] [blame^] | 70 | /** |
| 71 | * Returns a union set of this instance and the given instance. |
| 72 | * Note: This method returns a new instance, not mutate the current instance |
| 73 | * |
| 74 | * @param other other instance |
| 75 | * @return a new DiscreteResources instance representing a union set |
| 76 | */ |
Sho SHIMIZU | 32f57e9 | 2016-05-18 10:23:06 -0700 | [diff] [blame] | 77 | DiscreteResources add(DiscreteResources other); |
Sho SHIMIZU | b85000d | 2016-05-17 14:00:05 -0700 | [diff] [blame] | 78 | |
Sho SHIMIZU | 94e8a16 | 2016-05-19 17:09:59 -0700 | [diff] [blame^] | 79 | /** |
| 80 | * Returns a difference set of this instance and the given resources. |
| 81 | * Note: This method returns a new instance, not mutate the current intance. |
| 82 | * |
| 83 | * @param removed resources |
| 84 | * @return a new DiscreteResources instance representing a difference set |
| 85 | */ |
Sho SHIMIZU | 32f57e9 | 2016-05-18 10:23:06 -0700 | [diff] [blame] | 86 | DiscreteResources remove(List<DiscreteResource> removed); |
Sho SHIMIZU | b85000d | 2016-05-17 14:00:05 -0700 | [diff] [blame] | 87 | |
Sho SHIMIZU | 94e8a16 | 2016-05-19 17:09:59 -0700 | [diff] [blame^] | 88 | /** |
| 89 | * Returns all of resources this instance holds. |
| 90 | * |
| 91 | * @return all resources |
| 92 | */ |
Sho SHIMIZU | 32f57e9 | 2016-05-18 10:23:06 -0700 | [diff] [blame] | 93 | Set<DiscreteResource> values(); |
Sho SHIMIZU | b85000d | 2016-05-17 14:00:05 -0700 | [diff] [blame] | 94 | } |