| tom | f5d85d4 | 2014-10-02 05:27:56 -0700 | [diff] [blame] | 1 | package org.onlab.onos.net; |
| 2 | |
| 3 | import java.util.Set; |
| 4 | |
| 5 | /** |
| tom | 44179d6 | 2014-10-02 05:31:25 -0700 | [diff] [blame] | 6 | * Represents an set of sparse key/value string annotations capable of carrying |
| 7 | * annotation keys tagged for removal. |
| tom | f5d85d4 | 2014-10-02 05:27:56 -0700 | [diff] [blame] | 8 | */ |
| 9 | public interface SparseAnnotations extends Annotations { |
| 10 | |
| 11 | /** |
| 12 | * {@inheritDoc} |
| 13 | * <p/> |
| 14 | * Note that this set includes keys for any attributes tagged for removal. |
| 15 | */ |
| 16 | @Override |
| 17 | public Set<String> keys(); |
| 18 | |
| 19 | /** |
| 20 | * Indicates whether the specified key has been tagged as removed. This is |
| 21 | * used to for merging sparse annotation sets. |
| 22 | * |
| 23 | * @param key annotation key |
| 24 | * @return true if the previous annotation has been tagged for removal |
| 25 | */ |
| 26 | public boolean isRemoved(String key); |
| 27 | |
| 28 | } |