Package org.eclipse.ditto.things.model.signals.acks

Class ThingAcknowledgementFactory

java.lang.Object

org.eclipse.ditto.things.model.signals.acks.ThingAcknowledgementFactory

@Immutable
public final class ThingAcknowledgementFactory
extends java.lang.Object

This class provides factory methods for getting instances of Acknowledgement in the context of Thing entity.

Since:

1.1.0

Method Summary

Modifier and Type	Method	Description
static org.eclipse.ditto.base.model.signals.acks.Acknowledgement	newAcknowledgement(org.eclipse.ditto.base.model.acks.AcknowledgementLabel label, ThingId thingId, org.eclipse.ditto.base.model.common.HttpStatus httpStatus, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)	Returns a new Acknowledgement instance.
static org.eclipse.ditto.base.model.signals.acks.Acknowledgement	newAcknowledgement(org.eclipse.ditto.base.model.acks.AcknowledgementLabel label, ThingId thingId, org.eclipse.ditto.base.model.common.HttpStatus httpStatus, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders, org.eclipse.ditto.json.JsonValue payload)	Returns a new Acknowledgement instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

newAcknowledgement

public static org.eclipse.ditto.base.model.signals.acks.Acknowledgement newAcknowledgement(org.eclipse.ditto.base.model.acks.AcknowledgementLabel label,
                                                                                           ThingId thingId,
                                                                                           org.eclipse.ditto.base.model.common.HttpStatus httpStatus,
                                                                                           org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders,
                                                                                           @Nullable
                                                                                           org.eclipse.ditto.json.JsonValue payload)

Returns a new Acknowledgement instance.

Parameters:

label - the label of the new Acknowledgement.

thingId - the ID of the affected Thing being acknowledged.

httpStatus - the HTTP status of the Acknowledgement.

dittoHeaders - the DittoHeaders.

payload - the optional payload of the Acknowledgement.

Returns:

the instance.

Throws:

java.lang.NullPointerException - if any argument is null.

java.lang.IllegalArgumentException - if thingId is empty.

Since:

2.0.0

newAcknowledgement

public static org.eclipse.ditto.base.model.signals.acks.Acknowledgement newAcknowledgement(org.eclipse.ditto.base.model.acks.AcknowledgementLabel label,
                                                                                           ThingId thingId,
                                                                                           org.eclipse.ditto.base.model.common.HttpStatus httpStatus,
                                                                                           org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)

Returns a new Acknowledgement instance.

Parameters:

label - the label of the new Acknowledgement.

thingId - the ID of the affected Thing being acknowledged.

httpStatus - the HTTP status of the Acknowledgement.

dittoHeaders - the DittoHeaders.

Returns:

the instance.

Throws:

java.lang.NullPointerException - if any argument is null.

java.lang.IllegalArgumentException - if thingId is empty.

Since:

2.0.0