Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2014-present Open Networking Foundation |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -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 | */ |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 16 | package org.onosproject.net; |
tom | f5d85d4 | 2014-10-02 05:27:56 -0700 | [diff] [blame] | 17 | |
| 18 | import java.util.Set; |
| 19 | |
| 20 | /** |
tom | 44179d6 | 2014-10-02 05:31:25 -0700 | [diff] [blame] | 21 | * Represents an set of sparse key/value string annotations capable of carrying |
| 22 | * annotation keys tagged for removal. |
tom | f5d85d4 | 2014-10-02 05:27:56 -0700 | [diff] [blame] | 23 | */ |
| 24 | public interface SparseAnnotations extends Annotations { |
| 25 | |
| 26 | /** |
| 27 | * {@inheritDoc} |
Thomas Vachuska | 4b42077 | 2014-10-30 16:46:17 -0700 | [diff] [blame] | 28 | * <p> |
tom | f5d85d4 | 2014-10-02 05:27:56 -0700 | [diff] [blame] | 29 | * Note that this set includes keys for any attributes tagged for removal. |
Thomas Vachuska | 4b42077 | 2014-10-30 16:46:17 -0700 | [diff] [blame] | 30 | * </p> |
tom | f5d85d4 | 2014-10-02 05:27:56 -0700 | [diff] [blame] | 31 | */ |
| 32 | @Override |
Sho SHIMIZU | 3310a34 | 2015-05-13 12:14:05 -0700 | [diff] [blame] | 33 | Set<String> keys(); |
tom | f5d85d4 | 2014-10-02 05:27:56 -0700 | [diff] [blame] | 34 | |
| 35 | /** |
| 36 | * Indicates whether the specified key has been tagged as removed. This is |
Marc De Leenheer | bb38235 | 2015-04-23 18:20:34 -0700 | [diff] [blame] | 37 | * used for merging sparse annotation sets. |
tom | f5d85d4 | 2014-10-02 05:27:56 -0700 | [diff] [blame] | 38 | * |
| 39 | * @param key annotation key |
| 40 | * @return true if the previous annotation has been tagged for removal |
| 41 | */ |
Sho SHIMIZU | 3310a34 | 2015-05-13 12:14:05 -0700 | [diff] [blame] | 42 | boolean isRemoved(String key); |
tom | f5d85d4 | 2014-10-02 05:27:56 -0700 | [diff] [blame] | 43 | |
| 44 | } |