Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 1 | /* |
Ray Milkey | 34c9590 | 2015-04-15 09:47:53 -0700 | [diff] [blame] | 2 | * Copyright 2014-2015 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.event; |
tom | e33cc1a | 2014-08-25 21:59:41 -0700 | [diff] [blame] | 17 | |
| 18 | /** |
tom | 96dfcab | 2014-08-28 09:26:03 -0700 | [diff] [blame] | 19 | * Abstraction of an of a time-stamped event pertaining to an arbitrary subject. |
tom | e33cc1a | 2014-08-25 21:59:41 -0700 | [diff] [blame] | 20 | */ |
Sho SHIMIZU | 3c01833 | 2015-02-03 14:06:10 -0800 | [diff] [blame] | 21 | public interface Event<T extends Enum, S> { |
tom | e33cc1a | 2014-08-25 21:59:41 -0700 | [diff] [blame] | 22 | |
| 23 | /** |
| 24 | * Returns the timestamp of when the event occurred, given in milliseconds |
| 25 | * since the start of epoch. |
| 26 | * |
| 27 | * @return timestamp in milliseconds |
| 28 | */ |
| 29 | long time(); |
| 30 | |
| 31 | /** |
| 32 | * Returns the type of the event. |
| 33 | * |
| 34 | * @return event type |
| 35 | */ |
| 36 | T type(); |
| 37 | |
| 38 | /** |
| 39 | * Returns the subject of the event. |
| 40 | * |
| 41 | * @return subject to which this event pertains |
| 42 | */ |
| 43 | S subject(); |
| 44 | |
| 45 | } |