aboutsummaryrefslogtreecommitdiffstats
path: root/framework/src/onos/core/api/src/main/java/org/onosproject/net/Annotations.java
diff options
context:
space:
mode:
Diffstat (limited to 'framework/src/onos/core/api/src/main/java/org/onosproject/net/Annotations.java')
-rw-r--r--framework/src/onos/core/api/src/main/java/org/onosproject/net/Annotations.java40
1 files changed, 40 insertions, 0 deletions
diff --git a/framework/src/onos/core/api/src/main/java/org/onosproject/net/Annotations.java b/framework/src/onos/core/api/src/main/java/org/onosproject/net/Annotations.java
new file mode 100644
index 00000000..4ed70601
--- /dev/null
+++ b/framework/src/onos/core/api/src/main/java/org/onosproject/net/Annotations.java
@@ -0,0 +1,40 @@
+/*
+ * Copyright 2014 Open Networking Laboratory
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.onosproject.net;
+
+import java.util.Set;
+
+/**
+ * Represents an set of simple key/value string annotations.
+ */
+public interface Annotations {
+
+ /**
+ * Returns the set of keys for available annotations.
+ *
+ * @return annotation keys
+ */
+ Set<String> keys();
+
+ /**
+ * Returns the value of the specified annotation.
+ *
+ * @param key annotation key
+ * @return annotation value
+ */
+ String value(String key);
+
+}