Simon Hunt | cda9c03 | 2016-04-11 10:32:54 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | 0a4e674 | 2016-09-15 23:03:10 -0700 | [diff] [blame] | 2 | * Copyright 2016-present Open Networking Laboratory |
Simon Hunt | cda9c03 | 2016-04-11 10:32:54 -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 | */ |
| 16 | |
| 17 | package org.onosproject.ui.impl.topo.model; |
| 18 | |
Simon Hunt | 8eac4ae | 2017-01-20 12:56:45 -0800 | [diff] [blame^] | 19 | import com.fasterxml.jackson.databind.node.ObjectNode; |
Simon Hunt | cda9c03 | 2016-04-11 10:32:54 -0700 | [diff] [blame] | 20 | import org.onosproject.event.AbstractEvent; |
| 21 | import org.onosproject.ui.model.topo.UiElement; |
| 22 | |
| 23 | /** |
| 24 | * UI Topology model events. |
| 25 | */ |
| 26 | public class UiModelEvent extends AbstractEvent<UiModelEvent.Type, UiElement> { |
| 27 | |
Simon Hunt | 8eac4ae | 2017-01-20 12:56:45 -0800 | [diff] [blame^] | 28 | /** |
| 29 | * Enumeration of event types. |
| 30 | */ |
Simon Hunt | cda9c03 | 2016-04-11 10:32:54 -0700 | [diff] [blame] | 31 | enum Type { |
Simon Hunt | 642bc45 | 2016-05-04 19:34:45 -0700 | [diff] [blame] | 32 | CLUSTER_MEMBER_ADDED_OR_UPDATED, |
| 33 | CLUSTER_MEMBER_REMOVED, |
| 34 | |
Simon Hunt | c0f20c1 | 2016-05-09 09:30:20 -0700 | [diff] [blame] | 35 | REGION_ADDED_OR_UPDATED, |
| 36 | REGION_REMOVED, |
| 37 | |
Simon Hunt | 642bc45 | 2016-05-04 19:34:45 -0700 | [diff] [blame] | 38 | DEVICE_ADDED_OR_UPDATED, |
Simon Hunt | cda9c03 | 2016-04-11 10:32:54 -0700 | [diff] [blame] | 39 | DEVICE_REMOVED, |
Simon Hunt | 642bc45 | 2016-05-04 19:34:45 -0700 | [diff] [blame] | 40 | |
Simon Hunt | c0f20c1 | 2016-05-09 09:30:20 -0700 | [diff] [blame] | 41 | LINK_ADDED_OR_UPDATED, |
| 42 | LINK_REMOVED, |
| 43 | |
| 44 | HOST_ADDED_OR_UPDATED, |
| 45 | HOST_MOVED, |
| 46 | HOST_REMOVED |
Simon Hunt | cda9c03 | 2016-04-11 10:32:54 -0700 | [diff] [blame] | 47 | } |
Simon Hunt | 8eac4ae | 2017-01-20 12:56:45 -0800 | [diff] [blame^] | 48 | |
| 49 | private final ObjectNode data; |
| 50 | private final String memo; |
| 51 | |
| 52 | /** |
| 53 | * Creates a UI model event. Note that the memo field can be used to |
| 54 | * pass a hint to the listener about the event. |
| 55 | * |
| 56 | * @param type event type |
| 57 | * @param subject subject of the event |
| 58 | * @param data data containing details of the subject |
| 59 | * @param memo a note about the event |
| 60 | */ |
| 61 | protected UiModelEvent(Type type, UiElement subject, ObjectNode data, |
| 62 | String memo) { |
| 63 | super(type, subject); |
| 64 | this.data = data; |
| 65 | this.memo = memo; |
| 66 | } |
| 67 | |
| 68 | /** |
| 69 | * Returns the data of the subject. |
| 70 | * |
| 71 | * @return the subject data |
| 72 | */ |
| 73 | public ObjectNode data() { |
| 74 | return data; |
| 75 | } |
| 76 | |
| 77 | /** |
| 78 | * Returns the memo. |
| 79 | * |
| 80 | * @return the memo |
| 81 | */ |
| 82 | public String memo() { |
| 83 | return memo; |
| 84 | } |
| 85 | |
Simon Hunt | cda9c03 | 2016-04-11 10:32:54 -0700 | [diff] [blame] | 86 | } |