-
Notifications
You must be signed in to change notification settings - Fork 215
/
ThingCommandResponse.java
executable file
·71 lines (61 loc) · 2.44 KB
/
ThingCommandResponse.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
/*
* 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.commands;
import javax.annotation.Nullable;
import org.eclipse.ditto.base.model.headers.DittoHeaders;
import org.eclipse.ditto.base.model.json.FieldType;
import org.eclipse.ditto.base.model.json.JsonSchemaVersion;
import org.eclipse.ditto.base.model.signals.Signal;
import org.eclipse.ditto.base.model.signals.SignalWithEntityId;
import org.eclipse.ditto.base.model.signals.commands.CommandResponse;
import org.eclipse.ditto.json.JsonFactory;
import org.eclipse.ditto.json.JsonFieldDefinition;
import org.eclipse.ditto.things.model.WithThingId;
/**
* Aggregates all possible responses relating to a given {@link ThingCommand}.
*
* @param <T> the type of the implementing class.
*/
public interface ThingCommandResponse<T extends ThingCommandResponse<T>> extends CommandResponse<T>, WithThingId,
SignalWithEntityId<T> {
/**
* Type Prefix of Thing command responses.
*/
String TYPE_PREFIX = "things." + TYPE_QUALIFIER + ":";
@Override
default String getResourceType() {
return ThingCommand.RESOURCE_TYPE;
}
@Override
T setDittoHeaders(DittoHeaders dittoHeaders);
/**
* Indicates whether the specified signal argument is a {@link ThingCommandResponse}.
*
* @param signal the signal to be checked.
* @return {@code true} if {@code signal} is a {@code ThingCommandResponse}, {@code false} else.
* @since 3.0.0
*/
static boolean isThingCommandResponse(@Nullable final Signal<?> signal) {
return Signal.hasTypePrefix(signal, ThingCommandResponse.TYPE_PREFIX);
}
/**
* This class contains definitions for all specific fields of a {@code ThingCommandResponse}'s JSON representation.
*/
class JsonFields extends CommandResponse.JsonFields {
/**
* JSON field containing the ThingCommandResponse's thingId.
*/
public static final JsonFieldDefinition<String> JSON_THING_ID =
JsonFactory.newStringFieldDefinition("thingId", FieldType.REGULAR, JsonSchemaVersion.V_2);
}
}