org.eclipse.ditto.protocoladapter

Class ProtocolFactory

java.lang.Object

org.eclipse.ditto.protocoladapter.ProtocolFactory

public final class ProtocolFactory
extends Object

Factory for the Protocol Adapter library. Provides many static helper methods.

Method Summary

Modifier and Type	Method and Description
static org.eclipse.ditto.model.base.headers.DittoHeaders	emptyHeaders() Returns new empty Headers.
static TopicPath	emptyTopicPath() Returns an empty TopicPath.
static JsonifiableAdaptable	jsonifiableAdaptableFromJson(org.eclipse.ditto.json.JsonObject adaptableAsJson) Converts the passed in adaptableAsJson to a JsonifiableAdaptable.
static AdaptableBuilder	newAdaptableBuilder(Adaptable existingAdaptable) Returns a new AdaptableBuilder for the existing existingAdaptable.
static AdaptableBuilder	newAdaptableBuilder(Adaptable existingAdaptable, TopicPath overwriteTopicPath) Returns a new AdaptableBuilder for the existing existingAdaptable and a specific overwriteTopicPath to overwrite the one in existingAdaptable.
static AdaptableBuilder	newAdaptableBuilder(TopicPath topicPath) Returns a new AdaptableBuilder for the specified topicPath.
static org.eclipse.ditto.model.base.headers.DittoHeaders	newHeaders(Collection<Map.Entry<String,String>> headers) Returns new Headers for the specified headers map.
static org.eclipse.ditto.model.base.headers.DittoHeaders	newHeaders(org.eclipse.ditto.json.JsonObject headersAsJson) Returns new Headers for the specified headersAsJson.
static org.eclipse.ditto.model.base.headers.DittoHeaders	newHeadersWithDittoContentType(Map<String,String> headers) Returns new Headers for the specified headers map.
static Payload	newPayload(org.eclipse.ditto.json.JsonObject jsonObject) Returns a new Payload from the specified jsonObject.
static Payload	newPayload(String jsonString) Returns a new Payload from the specified jsonString.
static PayloadBuilder	newPayloadBuilder() Returns a new PayloadBuilder without a path.
static PayloadBuilder	newPayloadBuilder(org.eclipse.ditto.json.JsonPointer path) Returns a new PayloadBuilder for the specified path.
static TopicPath	newTopicPath(String path) Returns a new TopicPath for the specified path.
static TopicPathBuilder	newTopicPathBuilder(String thingId) Deprecated. Thing ID is now typed. Use newTopicPathBuilder(org.eclipse.ditto.model.things.ThingId) instead.
static TopicPathBuilder	newTopicPathBuilder(org.eclipse.ditto.model.things.ThingId thingId) Returns a new TopicPathBuilder for the specified thingId.
static TopicPathBuilder	newTopicPathBuilderFromNamespace(String namespace) Returns a new TopicPathBuilder.
static JsonifiableAdaptable	wrapAsJsonifiableAdaptable(Adaptable adaptable) Wraps the passed in adaptable to a JsonifiableAdaptable which has a JSON representation.

Methods inherited from class java.lang.Object

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

Method Detail

newAdaptableBuilder

public static AdaptableBuilder newAdaptableBuilder(TopicPath topicPath)

Returns a new AdaptableBuilder for the specified topicPath.

Parameters:

topicPath - the topic path.

Returns:

the builder.

newAdaptableBuilder

public static AdaptableBuilder newAdaptableBuilder(Adaptable existingAdaptable)

Returns a new AdaptableBuilder for the existing existingAdaptable.

Parameters:

existingAdaptable - the existingAdaptable to initialize the AdaptableBuilder with.

Returns:

the builder.

newAdaptableBuilder

public static AdaptableBuilder newAdaptableBuilder(Adaptable existingAdaptable,
                                                   TopicPath overwriteTopicPath)

Returns a new AdaptableBuilder for the existing existingAdaptable and a specific overwriteTopicPath to overwrite the one in existingAdaptable.

Parameters:

existingAdaptable - the existingAdaptable to initialize the AdaptableBuilder with.

overwriteTopicPath - the specific TopicPath to set as overwrite.

Returns:

the builder.

emptyTopicPath

public static TopicPath emptyTopicPath()

Returns an empty TopicPath.

Returns:

the topic path.

newTopicPath

public static TopicPath newTopicPath(String path)

Returns a new TopicPath for the specified path.

Parameters:

path - the path.

Returns:

the builder.

Throws:

NullPointerException - if path is null.

UnknownTopicPathException - if path is no valid TopicPath.

newTopicPathBuilder

@Deprecated
public static TopicPathBuilder newTopicPathBuilder(String thingId)

Deprecated. Thing ID is now typed. Use newTopicPathBuilder(org.eclipse.ditto.model.things.ThingId) instead.

Returns a new TopicPathBuilder for the specified thingId. The namespace and id part of the TopicPath will pe parsed from the thingId and set in the builder.

Parameters:

thingId - the id.

Returns:

the builder.

Throws:

NullPointerException - if thingId is null.

org.eclipse.ditto.model.things.ThingIdInvalidException - if thingId is not in the expected format.

newTopicPathBuilder

public static TopicPathBuilder newTopicPathBuilder(org.eclipse.ditto.model.things.ThingId thingId)

Returns a new TopicPathBuilder for the specified thingId. The namespace and id part of the TopicPath will pe parsed from the thingId and set in the builder.

Parameters:

thingId - the id.

Returns:

the builder.

Throws:

NullPointerException - if thingId is null.

org.eclipse.ditto.model.things.ThingIdInvalidException - if thingId is not in the expected format.

newTopicPathBuilderFromNamespace

public static TopicPathBuilder newTopicPathBuilderFromNamespace(String namespace)

Returns a new TopicPathBuilder. The id part of the TopicPath is set to TopicPath.ID_PLACEHOLDER.

Parameters:

namespace - the namespace.

Returns:

the builder.

Throws:

NullPointerException - if namespace is null.

newPayload

public static Payload newPayload(String jsonString)

Returns a new Payload from the specified jsonString.

Parameters:

jsonString - the JSON string.

Returns:

the payload.

Throws:

NullPointerException - if jsonString is null.

IllegalArgumentException - if jsonString is empty.

org.eclipse.ditto.json.JsonParseException - if jsonString does not contain a JSON object.

newPayload

public static Payload newPayload(org.eclipse.ditto.json.JsonObject jsonObject)

Returns a new Payload from the specified jsonObject.

Parameters:

jsonObject - the JSON object.

Returns:

the payload.

Throws:

NullPointerException - if jsonObject is null.

org.eclipse.ditto.json.JsonParseException - if jsonObject does not have the expected format.

newPayloadBuilder

public static PayloadBuilder newPayloadBuilder()

Returns a new PayloadBuilder without a path.

Returns:

the builder.

newPayloadBuilder

public static PayloadBuilder newPayloadBuilder(org.eclipse.ditto.json.JsonPointer path)

Returns a new PayloadBuilder for the specified path.

Parameters:

path - the path.

Returns:

the builder.

emptyHeaders

public static org.eclipse.ditto.model.base.headers.DittoHeaders emptyHeaders()

Returns new empty Headers.

Returns:

the headers.

newHeadersWithDittoContentType

public static org.eclipse.ditto.model.base.headers.DittoHeaders newHeadersWithDittoContentType(Map<String,String> headers)

Returns new Headers for the specified headers map.

Parameters:

headers - the headers map.

Returns:

the headers.

newHeaders

public static org.eclipse.ditto.model.base.headers.DittoHeaders newHeaders(Collection<Map.Entry<String,String>> headers)

Returns new Headers for the specified headers map.

Parameters:

headers - the headers map.

Returns:

the headers.

newHeaders

public static org.eclipse.ditto.model.base.headers.DittoHeaders newHeaders(org.eclipse.ditto.json.JsonObject headersAsJson)

Returns new Headers for the specified headersAsJson.

Parameters:

headersAsJson - the headers as JSON.

Returns:

the headers.

wrapAsJsonifiableAdaptable

public static JsonifiableAdaptable wrapAsJsonifiableAdaptable(Adaptable adaptable)

Wraps the passed in adaptable to a JsonifiableAdaptable which has a JSON representation.

Parameters:

adaptable - the already created Adaptable to wrap.

Returns:

the JsonifiableAdaptable.

jsonifiableAdaptableFromJson

public static JsonifiableAdaptable jsonifiableAdaptableFromJson(org.eclipse.ditto.json.JsonObject adaptableAsJson)

Converts the passed in adaptableAsJson to a JsonifiableAdaptable.

Parameters:

adaptableAsJson - the adaptable as JsonObject.

Returns:

the JsonifiableAdaptable.