tom | 2482e6f | 2014-10-01 16:51:48 -0700 | [diff] [blame^] | 1 | package org.onlab.onos.net; |
| 2 | |
| 3 | import java.util.Set; |
| 4 | |
| 5 | /** |
| 6 | * Represents an entity that carries arbitrary annotations. |
| 7 | */ |
| 8 | public interface Annotated { |
| 9 | |
| 10 | /** |
| 11 | * Returns the set of annotation keys currently available. |
| 12 | * |
| 13 | * @return set of annotation keys |
| 14 | */ |
| 15 | Set<String> annotationKeys(); |
| 16 | |
| 17 | /** |
| 18 | * Returns the annotation value for the specified key. |
| 19 | * |
| 20 | * @param key annotation key |
| 21 | * @return annotation value; null if there is no annotation |
| 22 | */ |
| 23 | String annotation(String key); |
| 24 | |
| 25 | } |