Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | 5ab426f | 2016-04-09 01:19:45 -0700 | [diff] [blame] | 2 | * Copyright 2014-present Open Networking Laboratory |
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 | 3ea1125 | 2014-10-02 04:32:26 -0700 | [diff] [blame] | 17 | |
tom | 3ea1125 | 2014-10-02 04:32:26 -0700 | [diff] [blame] | 18 | import java.util.Set; |
| 19 | |
| 20 | /** |
tom | 44179d6 | 2014-10-02 05:31:25 -0700 | [diff] [blame] | 21 | * Represents an set of simple key/value string annotations. |
tom | 3ea1125 | 2014-10-02 04:32:26 -0700 | [diff] [blame] | 22 | */ |
tom | f5d85d4 | 2014-10-02 05:27:56 -0700 | [diff] [blame] | 23 | public interface Annotations { |
tom | 3ea1125 | 2014-10-02 04:32:26 -0700 | [diff] [blame] | 24 | |
| 25 | /** |
tom | f5d85d4 | 2014-10-02 05:27:56 -0700 | [diff] [blame] | 26 | * Returns the set of keys for available annotations. |
tom | 3ea1125 | 2014-10-02 04:32:26 -0700 | [diff] [blame] | 27 | * |
| 28 | * @return annotation keys |
| 29 | */ |
Sho SHIMIZU | 3310a34 | 2015-05-13 12:14:05 -0700 | [diff] [blame] | 30 | Set<String> keys(); |
tom | 3ea1125 | 2014-10-02 04:32:26 -0700 | [diff] [blame] | 31 | |
| 32 | /** |
| 33 | * Returns the value of the specified annotation. |
| 34 | * |
| 35 | * @param key annotation key |
| 36 | * @return annotation value |
| 37 | */ |
Sho SHIMIZU | 3310a34 | 2015-05-13 12:14:05 -0700 | [diff] [blame] | 38 | String value(String key); |
tom | 3ea1125 | 2014-10-02 04:32:26 -0700 | [diff] [blame] | 39 | |
tom | 3ea1125 | 2014-10-02 04:32:26 -0700 | [diff] [blame] | 40 | } |