Skip to content

Commit

Permalink
#288 mark @SInCE annotations of merge command for adjustment
Browse files Browse the repository at this point in the history 
Signed-off-by: Vadim Guenther <vadim.guenther@bosch.io>
  • Loading branch information
@VadimGue
VadimGue committed Jan 29, 2021
1 parent 082d9de commit e22e488
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 3 deletions.
4 changes: 2 additions & 2 deletions java/src/main/java/org/eclipse/ditto/client/management/CommonManagement.java
View file
Expand Up @@ -311,7 +311,7 @@ public interface CommonManagement<T extends ThingHandle, F extends FeatureHandle
* @return completable future providing {@code null} in case of success or a specific {@link
* org.eclipse.ditto.model.base.exceptions.DittoRuntimeException} if the operation failed.
* @throws IllegalArgumentException if {@code argument} is {@code null}.
* @since 2.0.0
* TODO adapt @since annotation @since 1.6.0
*/
CompletableFuture<Void> merge(ThingId thingId, Thing thing, Option<?>... options);

Expand All @@ -325,7 +325,7 @@ public interface CommonManagement<T extends ThingHandle, F extends FeatureHandle
* @return completable future providing {@code null} in case of success or a specific {@link
* org.eclipse.ditto.model.base.exceptions.DittoRuntimeException} if the operation failed.
* @throws IllegalArgumentException if {@code argument} is {@code null}.
* @since 2.0.0
* TODO adapt @since annotation @since 1.6.0
*/
CompletableFuture<Void> merge(ThingId thingId, JsonObject thing, Option<?>... options);

Expand Down
1 change: 1 addition & 0 deletions java/src/main/java/org/eclipse/ditto/client/management/FeatureDefinitionManagement.java
View file
Expand Up @@ -52,6 +52,7 @@ public interface FeatureDefinitionManagement {
* @return a CompletableFuture providing the result of this operation or a specific {@link
* org.eclipse.ditto.model.base.exceptions.DittoRuntimeException} if the operation failed.
* @throws NullPointerException if any argument is {@code null}.
* TODO adapt @since annotation @since 1.6.0
*/
CompletableFuture<Void> mergeDefinition(FeatureDefinition definition, Option<?>... options);

Expand Down
8 changes: 8 additions & 0 deletions java/src/main/java/org/eclipse/ditto/client/management/FeaturePropertiesManagement.java
View file
Expand Up @@ -228,6 +228,7 @@ default CompletableFuture<Void> putProperty(final CharSequence path, final JsonV
* @return a completable future providing the result of this operation or a specific {@link
* org.eclipse.ditto.model.base.exceptions.DittoRuntimeException} if the operation failed
* @throws IllegalArgumentException if {@code path} is {@code null} or empty.
* TODO adapt @since annotation @since 1.6.0
*/
default CompletableFuture<Void> mergeProperty(final CharSequence path, final boolean value,
final Option<?>... options) {
Expand All @@ -246,6 +247,7 @@ default CompletableFuture<Void> mergeProperty(final CharSequence path, final boo
* @return a completable future providing the result of this operation or a specific {@link
* org.eclipse.ditto.model.base.exceptions.DittoRuntimeException} if the operation failed
* @throws IllegalArgumentException if {@code path} is {@code null} or empty.
* TODO adapt @since annotation @since 1.6.0
*/
default CompletableFuture<Void> mergeProperty(final CharSequence path, final double value,
final Option<?>... options) {
Expand All @@ -265,6 +267,7 @@ default CompletableFuture<Void> mergeProperty(final CharSequence path, final dou
* @return a completable future providing the result of this operation or a specific {@link
* org.eclipse.ditto.model.base.exceptions.DittoRuntimeException} if the operation failed
* @throws IllegalArgumentException if {@code path} is {@code null} or empty.
* TODO adapt @since annotation @since 1.6.0
*/
default CompletableFuture<Void> mergeProperty(final CharSequence path, final int value,
final Option<?>... options) {
Expand All @@ -284,6 +287,7 @@ default CompletableFuture<Void> mergeProperty(final CharSequence path, final int
* @return a completable future providing the result of this operation or a specific {@link
* org.eclipse.ditto.model.base.exceptions.DittoRuntimeException} if the operation failed
* @throws IllegalArgumentException if {@code path} is {@code null} or empty.
* TODO adapt @since annotation @since 1.6.0
*/
default CompletableFuture<Void> mergeProperty(final CharSequence path, final long value,
final Option<?>... options) {
Expand All @@ -303,6 +307,7 @@ default CompletableFuture<Void> mergeProperty(final CharSequence path, final lon
* @return a completable future providing the result of this operation or a specific {@link
* org.eclipse.ditto.model.base.exceptions.DittoRuntimeException} if the operation failed
* @throws IllegalArgumentException if {@code path} is {@code null} or empty.
* TODO adapt @since annotation @since 1.6.0
*/
default CompletableFuture<Void> mergeProperty(final CharSequence path, final String value,
final Option<?>... options) {
Expand All @@ -321,6 +326,7 @@ default CompletableFuture<Void> mergeProperty(final CharSequence path, final Str
* @return a completable future providing the result of this operation or a specific {@link
* org.eclipse.ditto.model.base.exceptions.DittoRuntimeException} if the operation failed
* @throws IllegalArgumentException if {@code path} is {@code null} or empty.
* TODO adapt @since annotation @since 1.6.0
*/
default CompletableFuture<Void> mergeProperty(final CharSequence path, final JsonValue value,
final Option<?>... options) {
Expand All @@ -338,6 +344,7 @@ default CompletableFuture<Void> mergeProperty(final CharSequence path, final Jso
* @return a completable future providing the result of this operation or a specific {@link
* org.eclipse.ditto.model.base.exceptions.DittoRuntimeException} if the operation failed
* @throws IllegalArgumentException if {@code path} is {@code null} or empty.
* TODO adapt @since annotation @since 1.6.0
*/
CompletableFuture<Void> mergeProperty(JsonPointer path, JsonValue value, Option<?>... options);

Expand All @@ -360,6 +367,7 @@ default CompletableFuture<Void> mergeProperty(final CharSequence path, final Jso
* org.eclipse.ditto.client.options.Options}.
* @return a completable future providing the result of this operation or a specific {@link
* org.eclipse.ditto.model.base.exceptions.DittoRuntimeException} if the operation failed
* TODO adapt @since annotation @since 1.6.0
*/
CompletableFuture<Void> mergeProperties(JsonObject value, Option<?>... options);

Expand Down
8 changes: 8 additions & 0 deletions java/src/main/java/org/eclipse/ditto/client/management/ThingAttributeManagement.java
View file
Expand Up @@ -231,6 +231,7 @@ default CompletableFuture<Void> putAttribute(final CharSequence path, final Json
* @return a completable future providing the result of this operation or a specific {@link
* org.eclipse.ditto.model.base.exceptions.DittoRuntimeException} if the operation failed
* @throws IllegalArgumentException if {@code path} is {@code null} or empty.
* TODO adapt @since annotation @since 1.6.0
*/
default CompletableFuture<Void> mergeAttribute(final CharSequence path, final boolean value,
final Option<?>... options) {
Expand All @@ -249,6 +250,7 @@ default CompletableFuture<Void> mergeAttribute(final CharSequence path, final bo
* @return a completable future providing the result of this operation or a specific {@link
* org.eclipse.ditto.model.base.exceptions.DittoRuntimeException} if the operation failed
* @throws IllegalArgumentException if {@code path} is {@code null} or empty.
* TODO adapt @since annotation @since 1.6.0
*/
default CompletableFuture<Void> mergeAttribute(final CharSequence path, final double value,
final Option<?>... options) {
Expand All @@ -267,6 +269,7 @@ default CompletableFuture<Void> mergeAttribute(final CharSequence path, final do
* @return a completable future providing the result of this operation or a specific {@link
* org.eclipse.ditto.model.base.exceptions.DittoRuntimeException} if the operation failed
* @throws IllegalArgumentException if {@code path} is {@code null} or empty.
* TODO adapt @since annotation @since 1.6.0
*/
default CompletableFuture<Void> mergeAttribute(final CharSequence path, final int value,
final Option<?>... options) {
Expand All @@ -285,6 +288,7 @@ default CompletableFuture<Void> mergeAttribute(final CharSequence path, final in
* @return a completable future providing the result of this operation or a specific {@link
* org.eclipse.ditto.model.base.exceptions.DittoRuntimeException} if the operation failed
* @throws IllegalArgumentException if {@code path} is {@code null} or empty.
* TODO adapt @since annotation @since 1.6.0
*/
default CompletableFuture<Void> mergeAttribute(final CharSequence path, final long value,
final Option<?>... options) {
Expand All @@ -303,6 +307,7 @@ default CompletableFuture<Void> mergeAttribute(final CharSequence path, final lo
* @return a completable future providing the result of this operation or a specific {@link
* org.eclipse.ditto.model.base.exceptions.DittoRuntimeException} if the operation failed
* @throws IllegalArgumentException if {@code path} is {@code null} or empty.
* TODO adapt @since annotation @since 1.6.0
*/
default CompletableFuture<Void> mergeAttribute(final CharSequence path, final String value,
final Option<?>... options) {
Expand All @@ -321,6 +326,7 @@ default CompletableFuture<Void> mergeAttribute(final CharSequence path, final St
* @return a completable future providing the result of this operation or a specific {@link
* org.eclipse.ditto.model.base.exceptions.DittoRuntimeException} if the operation failed
* @throws IllegalArgumentException if {@code path} is {@code null} or empty.
* TODO adapt @since annotation @since 1.6.0
*/
default CompletableFuture<Void> mergeAttribute(final CharSequence path, final JsonValue value,
final Option<?>... options) {
Expand All @@ -338,6 +344,7 @@ default CompletableFuture<Void> mergeAttribute(final CharSequence path, final Js
* @return a completable future providing the result of this operation or a specific {@link
* org.eclipse.ditto.model.base.exceptions.DittoRuntimeException} if the operation failed
* @throws IllegalArgumentException if any argument is {@code null} or if {@code path} is empty.
* TODO adapt @since annotation @since 1.6.0
*/
CompletableFuture<Void> mergeAttribute(JsonPointer path, JsonValue value, Option<?>... options);

Expand All @@ -362,6 +369,7 @@ default CompletableFuture<Void> mergeAttribute(final CharSequence path, final Js
* @return a completable future providing the result of this operation or a specific {@link
* org.eclipse.ditto.model.base.exceptions.DittoRuntimeException} if the operation failed
* @throws IllegalArgumentException if {@code value} is {@code null}
* TODO adapt @since annotation @since 1.6.0
*/
CompletableFuture<Void> mergeAttributes(JsonObject value, Option<?>... options);

Expand Down
4 changes: 3 additions & 1 deletion java/src/main/java/org/eclipse/ditto/client/management/ThingHandle.java
View file
Expand Up @@ -118,7 +118,7 @@ public interface ThingHandle<F extends FeatureHandle> extends WithThingId, Thing
* @return completable future for handling the result of the operation or a specific {@link
* org.eclipse.ditto.model.base.exceptions.DittoRuntimeException} if the operation failed
* @throws IllegalArgumentException if {@code policyId} is {@code null}.
* @since 1.1.0
* TODO adapt @since annotation @since 1.6.0
*/
CompletableFuture<Void> mergePolicyId(PolicyId policyId, Option<?>... options);

Expand All @@ -143,6 +143,7 @@ public interface ThingHandle<F extends FeatureHandle> extends WithThingId, Thing
* @return completable future for handling the result of the operation or a specific {@link
* org.eclipse.ditto.model.base.exceptions.DittoRuntimeException} if the operation failed
* @throws IllegalArgumentException if {@code features} is {@code null}.
* TODO adapt @since annotation @since 1.6.0
*/
CompletableFuture<Void> mergeFeatures(Features features, Option<?>... options);

Expand All @@ -167,6 +168,7 @@ public interface ThingHandle<F extends FeatureHandle> extends WithThingId, Thing
* @return completable future for handling the result of this operation or a specific {@link
* org.eclipse.ditto.model.base.exceptions.DittoRuntimeException} if the operation failed
* @throws IllegalArgumentException if {@code feature} is {@code null}.
* TODO adapt @since annotation @since 1.6.0
*/
CompletableFuture<Void> mergeFeature(Feature feature, Option<?>... options);

Expand Down

0 comments on commit e22e488

Please sign in to comment.