Thomas Vachuska | a8f4e7d | 2015-01-08 17:31:55 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2015 Open Networking Laboratory |
| 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 | */ |
| 16 | package org.onosproject.net.driver; |
| 17 | |
Thomas Vachuska | 80b0a80 | 2015-07-17 08:43:30 -0700 | [diff] [blame] | 18 | import org.onosproject.net.DeviceId; |
Thomas Vachuska | a8f4e7d | 2015-01-08 17:31:55 -0800 | [diff] [blame] | 19 | import org.onosproject.net.MutableAnnotations; |
| 20 | |
| 21 | /** |
| 22 | * Container for data about a device. Data is stored using |
| 23 | * {@link org.onosproject.net.MutableAnnotations}. |
| 24 | */ |
| 25 | public interface DriverData extends MutableAnnotations { |
| 26 | |
| 27 | /** |
| 28 | * Returns the parent device driver. |
| 29 | * |
| 30 | * @return device driver |
| 31 | */ |
Thomas Vachuska | ca88bb7 | 2015-04-08 19:38:02 -0700 | [diff] [blame] | 32 | Driver driver(); |
Thomas Vachuska | a8f4e7d | 2015-01-08 17:31:55 -0800 | [diff] [blame] | 33 | |
| 34 | /** |
Thomas Vachuska | 80b0a80 | 2015-07-17 08:43:30 -0700 | [diff] [blame] | 35 | * Returns the device identifier. |
| 36 | * |
| 37 | * @return device identifier |
| 38 | */ |
| 39 | DeviceId deviceId(); |
| 40 | |
| 41 | /** |
Thomas Vachuska | a8f4e7d | 2015-01-08 17:31:55 -0800 | [diff] [blame] | 42 | * Returns the specified facet of behaviour to access the device data. |
| 43 | * |
| 44 | * @param behaviourClass behaviour class |
| 45 | * @param <T> type of behaviour |
| 46 | * @return requested behaviour or null if not supported |
| 47 | */ |
| 48 | <T extends Behaviour> T behaviour(Class<T> behaviourClass); |
| 49 | |
| 50 | } |