-
Notifications
You must be signed in to change notification settings - Fork 215
/
FeaturesModified.java
executable file
·212 lines (182 loc) · 8.26 KB
/
FeaturesModified.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
/*
* Copyright (c) 2017 Contributors to the Eclipse Foundation
*
* See the NOTICE file(s) distributed with this work for additional
* information regarding copyright ownership.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0
*
* SPDX-License-Identifier: EPL-2.0
*/
package org.eclipse.ditto.things.model.signals.events;
import static org.eclipse.ditto.base.model.common.ConditionChecker.checkNotNull;
import java.time.Instant;
import java.util.Objects;
import java.util.Optional;
import java.util.function.Predicate;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;
import org.eclipse.ditto.base.model.entity.metadata.Metadata;
import org.eclipse.ditto.base.model.headers.DittoHeaders;
import org.eclipse.ditto.base.model.json.FieldType;
import org.eclipse.ditto.base.model.json.JsonParsableEvent;
import org.eclipse.ditto.base.model.json.JsonSchemaVersion;
import org.eclipse.ditto.base.model.signals.commands.Command;
import org.eclipse.ditto.base.model.signals.events.EventJsonDeserializer;
import org.eclipse.ditto.json.JsonFactory;
import org.eclipse.ditto.json.JsonField;
import org.eclipse.ditto.json.JsonFieldDefinition;
import org.eclipse.ditto.json.JsonObject;
import org.eclipse.ditto.json.JsonObjectBuilder;
import org.eclipse.ditto.json.JsonPointer;
import org.eclipse.ditto.json.JsonValue;
import org.eclipse.ditto.things.model.Features;
import org.eclipse.ditto.things.model.ThingId;
import org.eclipse.ditto.things.model.ThingsModelFactory;
/**
* This event is emitted after a Thing's {@link org.eclipse.ditto.things.model.Features} were modified.
*/
@Immutable
@JsonParsableEvent(name = FeaturesModified.NAME, typePrefix = ThingEvent.TYPE_PREFIX)
public final class FeaturesModified extends AbstractThingEvent<FeaturesModified>
implements ThingModifiedEvent<FeaturesModified> {
/**
* Name of the "Features Modified" event.
*/
public static final String NAME = "featuresModified";
/**
* Type of this event.
*/
public static final String TYPE = TYPE_PREFIX + NAME;
static final JsonFieldDefinition<JsonObject> JSON_FEATURES =
JsonFactory.newJsonObjectFieldDefinition("features", FieldType.REGULAR,
JsonSchemaVersion.V_2);
private final Features features;
private FeaturesModified(final ThingId thingId,
final Features features,
final long revision,
@Nullable final Instant timestamp,
final DittoHeaders dittoHeaders,
@Nullable final Metadata metadata) {
super(TYPE, thingId, revision, timestamp, dittoHeaders, metadata);
this.features = checkNotNull(features, "Features");
}
/**
* Constructs a new {@code FeaturesModified} object.
*
* @param thingId the ID of the Thing on which the Features was modified.
* @param features the modified {@link org.eclipse.ditto.things.model.Features}.
* @param revision the revision of the Thing.
* @param timestamp the timestamp of this event.
* @param dittoHeaders the headers of the command which was the cause of this event.
* @param metadata the metadata to apply for the event.
* @return the FeaturesModified created.
* @throws NullPointerException if any argument but {@code timestamp} and {@code metadata} is {@code null}.
* @since 1.3.0
*/
public static FeaturesModified of(final ThingId thingId,
final Features features,
final long revision,
@Nullable final Instant timestamp,
final DittoHeaders dittoHeaders,
@Nullable final Metadata metadata) {
return new FeaturesModified(thingId, features, revision, timestamp, dittoHeaders, metadata);
}
/**
* Creates a new {@code FeaturesModified} from a JSON string.
*
* @param jsonString the JSON string of which a new FeaturesModified instance is to be created.
* @param dittoHeaders the headers of the command which was the cause of this event.
* @return the {@code FeaturesModified} which was created from the given JSON string.
* @throws NullPointerException if any argument is {@code null}.
* @throws IllegalArgumentException if {@code jsonString} is empty.
* @throws org.eclipse.ditto.json.JsonParseException if the passed in {@code jsonString} was not in the expected
* 'FeaturesModified' format.
*/
public static FeaturesModified fromJson(final String jsonString, final DittoHeaders dittoHeaders) {
return fromJson(JsonFactory.newObject(jsonString), dittoHeaders);
}
/**
* Creates a new {@code FeaturesModified} from a JSON object.
*
* @param jsonObject the JSON object from which a new FeaturesModified instance is to be created.
* @param dittoHeaders the headers of the command which was the cause of this event.
* @return the {@code FeaturesModified} which was created from the given JSON object.
* @throws NullPointerException if any argument is {@code null}.
* @throws org.eclipse.ditto.json.JsonParseException if the passed in {@code jsonObject} was not in the expected
* 'FeaturesModified' format.
*/
public static FeaturesModified fromJson(final JsonObject jsonObject, final DittoHeaders dittoHeaders) {
return new EventJsonDeserializer<FeaturesModified>(TYPE, jsonObject).deserialize(
(revision, timestamp, metadata) -> {
final String extractedThingId = jsonObject.getValueOrThrow(ThingEvent.JsonFields.THING_ID);
final ThingId thingId = ThingId.of(extractedThingId);
final JsonObject featuresJsonObject = jsonObject.getValueOrThrow(JSON_FEATURES);
final Features extractedFeatures = ThingsModelFactory.newFeatures(featuresJsonObject);
return of(thingId, extractedFeatures, revision, timestamp, dittoHeaders, metadata);
});
}
/**
* Returns the modified {@link org.eclipse.ditto.things.model.Features}.
*
* @return the modified Features.
*/
public Features getFeatures() {
return features;
}
@Override
public Optional<JsonValue> getEntity(final JsonSchemaVersion schemaVersion) {
return Optional.of(features.toJson(schemaVersion, FieldType.notHidden()));
}
@Override
public JsonPointer getResourcePath() {
return JsonFactory.newPointer("/features");
}
@Override
public FeaturesModified setRevision(final long revision) {
return of(getEntityId(), features, revision, getTimestamp().orElse(null), getDittoHeaders(),
getMetadata().orElse(null));
}
@Override
public FeaturesModified setDittoHeaders(final DittoHeaders dittoHeaders) {
return of(getEntityId(), features, getRevision(), getTimestamp().orElse(null), dittoHeaders,
getMetadata().orElse(null));
}
@Override
public Command.Category getCommandCategory() {
return Command.Category.MODIFY;
}
@Override
protected void appendPayload(final JsonObjectBuilder jsonObjectBuilder,
final JsonSchemaVersion schemaVersion, final Predicate<JsonField> thePredicate) {
final Predicate<JsonField> predicate = schemaVersion.and(thePredicate);
jsonObjectBuilder.set(JSON_FEATURES, features.toJson(schemaVersion, thePredicate), predicate);
}
@SuppressWarnings("squid:S109")
@Override
public int hashCode() {
return Objects.hash(super.hashCode(), features);
}
@SuppressWarnings("squid:MethodCyclomaticComplexity")
@Override
public boolean equals(@Nullable final Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
final FeaturesModified that = (FeaturesModified) o;
return that.canEqual(this) && Objects.equals(features, that.features) && super.equals(that);
}
@Override
protected boolean canEqual(@Nullable final Object other) {
return other instanceof FeaturesModified;
}
@Override
public String toString() {
return getClass().getSimpleName() + " [" + super.toString() + ", features=" + features + "]";
}
}