alshabib | ab98466 | 2014-12-04 18:56:18 -0800 | [diff] [blame^] | 1 | /* |
| 2 | * Copyright 2014 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 | */ |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 16 | package org.onosproject.store.service.impl; |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 17 | |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 18 | import org.onosproject.store.service.VersionedValue; |
Madan Jampani | 9b37d57 | 2014-11-12 11:53:24 -0800 | [diff] [blame] | 19 | |
Madan Jampani | f5d263b | 2014-11-13 10:04:40 -0800 | [diff] [blame] | 20 | import com.google.common.base.MoreObjects; |
| 21 | |
Madan Jampani | 44e6a54 | 2014-11-12 01:06:51 -0800 | [diff] [blame] | 22 | /** |
| 23 | * A table modification event. |
| 24 | */ |
| 25 | public final class TableModificationEvent { |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 26 | |
Madan Jampani | 44e6a54 | 2014-11-12 01:06:51 -0800 | [diff] [blame] | 27 | /** |
| 28 | * Type of table modification event. |
Madan Jampani | 44e6a54 | 2014-11-12 01:06:51 -0800 | [diff] [blame] | 29 | */ |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 30 | public enum Type { |
| 31 | ROW_ADDED, |
| 32 | ROW_DELETED, |
| 33 | ROW_UPDATED |
| 34 | } |
Madan Jampani | 44e6a54 | 2014-11-12 01:06:51 -0800 | [diff] [blame] | 35 | |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 36 | private final String tableName; |
| 37 | private final String key; |
Madan Jampani | 9b37d57 | 2014-11-12 11:53:24 -0800 | [diff] [blame] | 38 | private final VersionedValue value; |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 39 | private final Type type; |
| 40 | |
Madan Jampani | 44e6a54 | 2014-11-12 01:06:51 -0800 | [diff] [blame] | 41 | /** |
| 42 | * Creates a new row deleted table modification event. |
| 43 | * @param tableName table name. |
| 44 | * @param key row key |
Madan Jampani | 9b37d57 | 2014-11-12 11:53:24 -0800 | [diff] [blame] | 45 | * @param value value associated with the key when it was deleted. |
Madan Jampani | 44e6a54 | 2014-11-12 01:06:51 -0800 | [diff] [blame] | 46 | * @return table modification event. |
| 47 | */ |
Madan Jampani | 9b37d57 | 2014-11-12 11:53:24 -0800 | [diff] [blame] | 48 | public static TableModificationEvent rowDeleted(String tableName, String key, VersionedValue value) { |
| 49 | return new TableModificationEvent(tableName, key, value, Type.ROW_DELETED); |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 50 | } |
Madan Jampani | 44e6a54 | 2014-11-12 01:06:51 -0800 | [diff] [blame] | 51 | |
| 52 | /** |
| 53 | * Creates a new row added table modification event. |
| 54 | * @param tableName table name. |
| 55 | * @param key row key |
Madan Jampani | 9b37d57 | 2014-11-12 11:53:24 -0800 | [diff] [blame] | 56 | * @param value value associated with the key |
Madan Jampani | 44e6a54 | 2014-11-12 01:06:51 -0800 | [diff] [blame] | 57 | * @return table modification event. |
| 58 | */ |
Madan Jampani | 9b37d57 | 2014-11-12 11:53:24 -0800 | [diff] [blame] | 59 | public static TableModificationEvent rowAdded(String tableName, String key, VersionedValue value) { |
| 60 | return new TableModificationEvent(tableName, key, value, Type.ROW_ADDED); |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 61 | } |
Madan Jampani | 44e6a54 | 2014-11-12 01:06:51 -0800 | [diff] [blame] | 62 | |
| 63 | /** |
| 64 | * Creates a new row updated table modification event. |
| 65 | * @param tableName table name. |
| 66 | * @param key row key |
Madan Jampani | 9b37d57 | 2014-11-12 11:53:24 -0800 | [diff] [blame] | 67 | * @param newValue value |
Madan Jampani | 44e6a54 | 2014-11-12 01:06:51 -0800 | [diff] [blame] | 68 | * @return table modification event. |
| 69 | */ |
Madan Jampani | 9b37d57 | 2014-11-12 11:53:24 -0800 | [diff] [blame] | 70 | public static TableModificationEvent rowUpdated(String tableName, String key, VersionedValue newValue) { |
| 71 | return new TableModificationEvent(tableName, key, newValue, Type.ROW_UPDATED); |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 72 | } |
| 73 | |
Madan Jampani | 9b37d57 | 2014-11-12 11:53:24 -0800 | [diff] [blame] | 74 | private TableModificationEvent(String tableName, String key, VersionedValue value, Type type) { |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 75 | this.tableName = tableName; |
| 76 | this.key = key; |
Madan Jampani | 9b37d57 | 2014-11-12 11:53:24 -0800 | [diff] [blame] | 77 | this.value = value; |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 78 | this.type = type; |
| 79 | } |
| 80 | |
Madan Jampani | 44e6a54 | 2014-11-12 01:06:51 -0800 | [diff] [blame] | 81 | /** |
| 82 | * Returns name of table this event is for. |
| 83 | * @return table name |
| 84 | */ |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 85 | public String tableName() { |
| 86 | return tableName; |
| 87 | } |
| 88 | |
Madan Jampani | 44e6a54 | 2014-11-12 01:06:51 -0800 | [diff] [blame] | 89 | /** |
| 90 | * Returns the row key this event is for. |
| 91 | * @return row key |
| 92 | */ |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 93 | public String key() { |
| 94 | return key; |
| 95 | } |
| 96 | |
Madan Jampani | 44e6a54 | 2014-11-12 01:06:51 -0800 | [diff] [blame] | 97 | /** |
Madan Jampani | 9b37d57 | 2014-11-12 11:53:24 -0800 | [diff] [blame] | 98 | * Returns the value associated with the key. If the event for a deletion, this |
| 99 | * method returns value that was deleted. |
| 100 | * @return row value |
| 101 | */ |
| 102 | public VersionedValue value() { |
| 103 | return value; |
| 104 | } |
| 105 | |
| 106 | /** |
Madan Jampani | 44e6a54 | 2014-11-12 01:06:51 -0800 | [diff] [blame] | 107 | * Returns the type of table modification event. |
| 108 | * @return event type. |
| 109 | */ |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 110 | public Type type() { |
| 111 | return type; |
| 112 | } |
Madan Jampani | f5d263b | 2014-11-13 10:04:40 -0800 | [diff] [blame] | 113 | |
| 114 | @Override |
| 115 | public String toString() { |
| 116 | return MoreObjects.toStringHelper(getClass()) |
| 117 | .add("type", type) |
| 118 | .add("tableName", tableName) |
| 119 | .add("key", key) |
| 120 | .add("version", value.version()) |
| 121 | .toString(); |
| 122 | } |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 123 | } |