Carmelo Cascone | b2e3dba | 2017-07-27 12:07:09 -0400 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2017-present Open Networking Foundation |
Carmelo Cascone | b2e3dba | 2017-07-27 12:07:09 -0400 | [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.net.pi.runtime; |
| 18 | |
| 19 | import com.google.common.annotations.Beta; |
| 20 | import com.google.common.base.MoreObjects; |
| 21 | import com.google.common.base.Objects; |
Carmelo Cascone | 4c289b7 | 2019-01-22 15:30:45 -0800 | [diff] [blame] | 22 | import org.onosproject.net.DeviceId; |
Carmelo Cascone | e44592f | 2018-09-12 02:24:47 -0700 | [diff] [blame] | 23 | import org.onosproject.net.pi.model.PiActionProfileId; |
Carmelo Cascone | b2e3dba | 2017-07-27 12:07:09 -0400 | [diff] [blame] | 24 | |
| 25 | import static com.google.common.base.Preconditions.checkNotNull; |
| 26 | |
| 27 | /** |
Carmelo Cascone | cb4327a | 2018-09-11 15:17:23 -0700 | [diff] [blame] | 28 | * Instance of a member of an action profile in a protocol-independent pipeline. |
Carmelo Cascone | b2e3dba | 2017-07-27 12:07:09 -0400 | [diff] [blame] | 29 | */ |
| 30 | @Beta |
Carmelo Cascone | cb4327a | 2018-09-11 15:17:23 -0700 | [diff] [blame] | 31 | public final class PiActionProfileMember implements PiEntity { |
Carmelo Cascone | b2e3dba | 2017-07-27 12:07:09 -0400 | [diff] [blame] | 32 | |
Carmelo Cascone | e44592f | 2018-09-12 02:24:47 -0700 | [diff] [blame] | 33 | private final PiActionProfileId actionProfileId; |
Carmelo Cascone | cb4327a | 2018-09-11 15:17:23 -0700 | [diff] [blame] | 34 | private final PiActionProfileMemberId memberId; |
Carmelo Cascone | b2e3dba | 2017-07-27 12:07:09 -0400 | [diff] [blame] | 35 | private final PiAction action; |
Carmelo Cascone | b2e3dba | 2017-07-27 12:07:09 -0400 | [diff] [blame] | 36 | |
Carmelo Cascone | cb4327a | 2018-09-11 15:17:23 -0700 | [diff] [blame] | 37 | private PiActionProfileMember(PiActionProfileId actionProfileId, |
| 38 | PiActionProfileMemberId memberId, |
Carmelo Cascone | 99c59db | 2019-01-17 15:39:35 -0800 | [diff] [blame] | 39 | PiAction action) { |
Carmelo Cascone | e44592f | 2018-09-12 02:24:47 -0700 | [diff] [blame] | 40 | this.actionProfileId = actionProfileId; |
Carmelo Cascone | cb4327a | 2018-09-11 15:17:23 -0700 | [diff] [blame] | 41 | this.memberId = memberId; |
Carmelo Cascone | b2e3dba | 2017-07-27 12:07:09 -0400 | [diff] [blame] | 42 | this.action = action; |
Carmelo Cascone | b2e3dba | 2017-07-27 12:07:09 -0400 | [diff] [blame] | 43 | } |
| 44 | |
| 45 | /** |
| 46 | * Returns the identifier of this member. |
| 47 | * |
| 48 | * @return member identifier |
| 49 | */ |
Carmelo Cascone | cb4327a | 2018-09-11 15:17:23 -0700 | [diff] [blame] | 50 | public PiActionProfileMemberId id() { |
| 51 | return memberId; |
Carmelo Cascone | b2e3dba | 2017-07-27 12:07:09 -0400 | [diff] [blame] | 52 | } |
| 53 | |
| 54 | /** |
Carmelo Cascone | e44592f | 2018-09-12 02:24:47 -0700 | [diff] [blame] | 55 | * Returns the identifier of the action profile. |
| 56 | * |
| 57 | * @return action profile identifier |
| 58 | */ |
| 59 | public PiActionProfileId actionProfile() { |
| 60 | return actionProfileId; |
| 61 | } |
| 62 | |
| 63 | /** |
Carmelo Cascone | b2e3dba | 2017-07-27 12:07:09 -0400 | [diff] [blame] | 64 | * Returns the action associated to this member. |
| 65 | * |
| 66 | * @return action |
| 67 | */ |
| 68 | public PiAction action() { |
| 69 | return action; |
| 70 | } |
| 71 | |
Carmelo Cascone | b2e3dba | 2017-07-27 12:07:09 -0400 | [diff] [blame] | 72 | @Override |
Carmelo Cascone | 5bc7e10 | 2018-02-18 18:27:55 -0800 | [diff] [blame] | 73 | public PiEntityType piEntityType() { |
Carmelo Cascone | cb4327a | 2018-09-11 15:17:23 -0700 | [diff] [blame] | 74 | return PiEntityType.ACTION_PROFILE_MEMBER; |
Carmelo Cascone | 5bc7e10 | 2018-02-18 18:27:55 -0800 | [diff] [blame] | 75 | } |
| 76 | |
| 77 | @Override |
Carmelo Cascone | 4c289b7 | 2019-01-22 15:30:45 -0800 | [diff] [blame] | 78 | public PiActionProfileMemberHandle handle(DeviceId deviceId) { |
| 79 | return PiActionProfileMemberHandle.of(deviceId, this); |
| 80 | } |
| 81 | |
| 82 | @Override |
Carmelo Cascone | b2e3dba | 2017-07-27 12:07:09 -0400 | [diff] [blame] | 83 | public boolean equals(Object o) { |
| 84 | if (this == o) { |
| 85 | return true; |
| 86 | } |
Carmelo Cascone | cb4327a | 2018-09-11 15:17:23 -0700 | [diff] [blame] | 87 | if (!(o instanceof PiActionProfileMember)) { |
Carmelo Cascone | b2e3dba | 2017-07-27 12:07:09 -0400 | [diff] [blame] | 88 | return false; |
| 89 | } |
Carmelo Cascone | cb4327a | 2018-09-11 15:17:23 -0700 | [diff] [blame] | 90 | PiActionProfileMember that = (PiActionProfileMember) o; |
Carmelo Cascone | 99c59db | 2019-01-17 15:39:35 -0800 | [diff] [blame] | 91 | return Objects.equal(actionProfileId, that.actionProfileId) && |
Carmelo Cascone | cb4327a | 2018-09-11 15:17:23 -0700 | [diff] [blame] | 92 | Objects.equal(memberId, that.memberId) && |
Carmelo Cascone | b2e3dba | 2017-07-27 12:07:09 -0400 | [diff] [blame] | 93 | Objects.equal(action, that.action); |
| 94 | } |
| 95 | |
| 96 | @Override |
| 97 | public int hashCode() { |
Carmelo Cascone | 99c59db | 2019-01-17 15:39:35 -0800 | [diff] [blame] | 98 | return Objects.hashCode(actionProfileId, memberId, action); |
Carmelo Cascone | b2e3dba | 2017-07-27 12:07:09 -0400 | [diff] [blame] | 99 | } |
| 100 | |
| 101 | @Override |
| 102 | public String toString() { |
| 103 | return MoreObjects.toStringHelper(this) |
Carmelo Cascone | e44592f | 2018-09-12 02:24:47 -0700 | [diff] [blame] | 104 | .add("actionProfile", actionProfileId) |
Carmelo Cascone | cb4327a | 2018-09-11 15:17:23 -0700 | [diff] [blame] | 105 | .add("id", memberId) |
Carmelo Cascone | b2e3dba | 2017-07-27 12:07:09 -0400 | [diff] [blame] | 106 | .add("action", action) |
Carmelo Cascone | b2e3dba | 2017-07-27 12:07:09 -0400 | [diff] [blame] | 107 | .toString(); |
| 108 | } |
| 109 | |
| 110 | /** |
Carmelo Cascone | cb4327a | 2018-09-11 15:17:23 -0700 | [diff] [blame] | 111 | * Returns a new builder of action profile members. |
Carmelo Cascone | b2e3dba | 2017-07-27 12:07:09 -0400 | [diff] [blame] | 112 | * |
| 113 | * @return member builder |
| 114 | */ |
| 115 | public static Builder builder() { |
| 116 | return new Builder(); |
| 117 | } |
| 118 | |
| 119 | /** |
Carmelo Cascone | cb4327a | 2018-09-11 15:17:23 -0700 | [diff] [blame] | 120 | * Builder of action profile members. |
Carmelo Cascone | b2e3dba | 2017-07-27 12:07:09 -0400 | [diff] [blame] | 121 | */ |
| 122 | public static final class Builder { |
| 123 | |
Carmelo Cascone | e44592f | 2018-09-12 02:24:47 -0700 | [diff] [blame] | 124 | private PiActionProfileId actionProfileId; |
Carmelo Cascone | 99c59db | 2019-01-17 15:39:35 -0800 | [diff] [blame] | 125 | private PiActionProfileMemberId memberId; |
Carmelo Cascone | b2e3dba | 2017-07-27 12:07:09 -0400 | [diff] [blame] | 126 | private PiAction action; |
Carmelo Cascone | b2e3dba | 2017-07-27 12:07:09 -0400 | [diff] [blame] | 127 | |
| 128 | private Builder() { |
| 129 | // Hides constructor. |
| 130 | } |
| 131 | |
| 132 | /** |
Carmelo Cascone | e44592f | 2018-09-12 02:24:47 -0700 | [diff] [blame] | 133 | * Sets the action profile identifier of this member. |
| 134 | * |
| 135 | * @param actionProfileId action profile identifier |
| 136 | * @return this |
| 137 | */ |
| 138 | public Builder forActionProfile(PiActionProfileId actionProfileId) { |
| 139 | this.actionProfileId = actionProfileId; |
| 140 | return this; |
| 141 | } |
| 142 | |
| 143 | /** |
Carmelo Cascone | b2e3dba | 2017-07-27 12:07:09 -0400 | [diff] [blame] | 144 | * Sets the identifier of this member. |
| 145 | * |
| 146 | * @param id member identifier |
| 147 | * @return this |
| 148 | */ |
Carmelo Cascone | cb4327a | 2018-09-11 15:17:23 -0700 | [diff] [blame] | 149 | public Builder withId(PiActionProfileMemberId id) { |
Carmelo Cascone | 99c59db | 2019-01-17 15:39:35 -0800 | [diff] [blame] | 150 | this.memberId = id; |
Carmelo Cascone | b2e3dba | 2017-07-27 12:07:09 -0400 | [diff] [blame] | 151 | return this; |
| 152 | } |
| 153 | |
| 154 | /** |
| 155 | * Sets the action of this member. |
| 156 | * |
| 157 | * @param action action |
| 158 | * @return this |
| 159 | */ |
| 160 | public Builder withAction(PiAction action) { |
| 161 | this.action = action; |
| 162 | return this; |
| 163 | } |
| 164 | |
| 165 | /** |
Carmelo Cascone | cb4327a | 2018-09-11 15:17:23 -0700 | [diff] [blame] | 166 | * Creates a new action profile member. |
Carmelo Cascone | b2e3dba | 2017-07-27 12:07:09 -0400 | [diff] [blame] | 167 | * |
Carmelo Cascone | cb4327a | 2018-09-11 15:17:23 -0700 | [diff] [blame] | 168 | * @return action profile member |
Carmelo Cascone | b2e3dba | 2017-07-27 12:07:09 -0400 | [diff] [blame] | 169 | */ |
Carmelo Cascone | cb4327a | 2018-09-11 15:17:23 -0700 | [diff] [blame] | 170 | public PiActionProfileMember build() { |
Carmelo Cascone | e44592f | 2018-09-12 02:24:47 -0700 | [diff] [blame] | 171 | checkNotNull(actionProfileId); |
Carmelo Cascone | 99c59db | 2019-01-17 15:39:35 -0800 | [diff] [blame] | 172 | checkNotNull(memberId); |
Carmelo Cascone | b2e3dba | 2017-07-27 12:07:09 -0400 | [diff] [blame] | 173 | checkNotNull(action); |
Carmelo Cascone | 99c59db | 2019-01-17 15:39:35 -0800 | [diff] [blame] | 174 | return new PiActionProfileMember(actionProfileId, memberId, action); |
Carmelo Cascone | b2e3dba | 2017-07-27 12:07:09 -0400 | [diff] [blame] | 175 | } |
| 176 | } |
| 177 | } |