blob: 1dc4b38caa7a661063ab2fc367e31ecdc8b8d051 [file] [log] [blame]
tom3ea11252014-10-02 04:32:26 -07001package org.onlab.onos.net;
2
tom3ea11252014-10-02 04:32:26 -07003import java.util.Set;
4
5/**
tom44179d62014-10-02 05:31:25 -07006 * Represents an set of simple key/value string annotations.
tom3ea11252014-10-02 04:32:26 -07007 */
tomf5d85d42014-10-02 05:27:56 -07008public interface Annotations {
tom3ea11252014-10-02 04:32:26 -07009
10 /**
tomf5d85d42014-10-02 05:27:56 -070011 * Returns the set of keys for available annotations.
tom3ea11252014-10-02 04:32:26 -070012 *
13 * @return annotation keys
14 */
tomf5d85d42014-10-02 05:27:56 -070015 public Set<String> keys();
tom3ea11252014-10-02 04:32:26 -070016
17 /**
18 * Returns the value of the specified annotation.
19 *
20 * @param key annotation key
21 * @return annotation value
22 */
tomf5d85d42014-10-02 05:27:56 -070023 public String value(String key);
tom3ea11252014-10-02 04:32:26 -070024
tom3ea11252014-10-02 04:32:26 -070025}