/
DeleteFeatureDesiredPropertiesLiveCommandAnswerBuilder.java
85 lines (75 loc) · 3.23 KB
/
DeleteFeatureDesiredPropertiesLiveCommandAnswerBuilder.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
/*
* Copyright (c) 2020 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.signals.commands.live.modify;
import javax.annotation.Nonnull;
import org.eclipse.ditto.signals.commands.live.base.LiveCommandAnswerBuilder;
import org.eclipse.ditto.signals.commands.live.base.LiveCommandResponseFactory;
import org.eclipse.ditto.signals.commands.live.base.LiveEventFactory;
import org.eclipse.ditto.signals.commands.things.ThingErrorResponse;
import org.eclipse.ditto.signals.commands.things.modify.DeleteFeatureDesiredProperties;
import org.eclipse.ditto.signals.commands.things.modify.DeleteFeatureDesiredPropertiesResponse;
import org.eclipse.ditto.signals.events.things.FeatureDesiredPropertiesDeleted;
/**
* LiveCommandAnswer builder for producing {@code CommandResponse}s and {@code Event}s for {@link
* DeleteFeatureDesiredProperties} commands.
*
* @since 1.4.0
*/
public interface DeleteFeatureDesiredPropertiesLiveCommandAnswerBuilder
extends
LiveCommandAnswerBuilder.ModifyCommandResponseStep<DeleteFeatureDesiredPropertiesLiveCommandAnswerBuilder.ResponseFactory,
DeleteFeatureDesiredPropertiesLiveCommandAnswerBuilder.EventFactory> {
/**
* Factory for {@code CommandResponse}s to {@link DeleteFeatureDesiredProperties} command.
*/
interface ResponseFactory extends LiveCommandResponseFactory {
/**
* Builds a {@link DeleteFeatureDesiredPropertiesResponse} using the values of the {@code Command}.
*
* @return the response.
*/
@Nonnull
DeleteFeatureDesiredPropertiesResponse deleted();
/**
* Builds a {@link ThingErrorResponse} indicating that the features desired properties were not accessible.
*
* @return the response.
* @see org.eclipse.ditto.signals.commands.things.exceptions.FeatureDesiredPropertiesNotAccessibleException
* FeatureDesiredPropertiesNotAccessibleException
*/
@Nonnull
ThingErrorResponse featureDesiredPropertiesNotAccessibleError();
/**
* Builds a {@link ThingErrorResponse} indicating that the feature properties were not modifiable.
*
* @return the response.
* @see org.eclipse.ditto.signals.commands.things.exceptions.FeatureDesiredPropertiesNotModifiableException
* FeatureDesiredPropertiesNotModifiableException
*/
@Nonnull
ThingErrorResponse featureDesiredPropertiesNotModifiableError();
}
/**
* Factory for events triggered by {@link DeleteFeatureDesiredProperties} command.
*/
@SuppressWarnings("squid:S1609")
interface EventFactory extends LiveEventFactory {
/**
* Creates a {@link FeatureDesiredPropertiesDeleted} event using the values of the {@code Command}.
*
* @return the event.
*/
@Nonnull
FeatureDesiredPropertiesDeleted deleted();
}
}