Package net.webpdf.wsclient.tools

Class SerializeHelper

java.lang.Object

net.webpdf.wsclient.tools.SerializeHelper

public class SerializeHelper
extends Object

The SerializeHelper provides a set of tools, to translate the server´s responses and data transfer objects, which may be provided using one of the defined DataFormats.

Method Summary

Modifier and Type	Method	Description
static <T> T	fromJSON(@Nullable StreamSource streamSource, @NotNull Class<T> type)	Deserialize the data transfer object to the given type from the given DataFormat.JSON StreamSource.
static <T> T	fromJSON(@Nullable org.apache.hc.core5.http.HttpEntity httpEntity, @NotNull Class<T> type)	Deserialize the data transfer object to the given type from the given DataFormat.JSON HttpEntity.
static <T> T	fromXML(@Nullable StreamSource streamSource, @NotNull Class<T> type)	Deserialize the data transfer object to the given type from the given DataFormat.XML StreamSource.
static <T> T	fromXML(@Nullable org.apache.hc.core5.http.HttpEntity httpEntity, @NotNull Class<T> type)	Deserialize the data transfer object to the given type from the given DataFormat.XML HttpEntity.
static @NotNull String	toJSON(@Nullable Object object)	Serialize a data transfer object to DataFormat.JSON
static @NotNull String	toXML(@Nullable Object object, @NotNull Class<?> type)	Serialize a data transfer object to DataFormat.XML.

Methods inherited from class java.lang.Object

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

Method Detail

fromXML

@NotNull
public static <T> T fromXML(@Nullable
                            @Nullable org.apache.hc.core5.http.HttpEntity httpEntity,
                            @NotNull
                            @NotNull Class<T> type)
                     throws ResultException

Deserialize the data transfer object to the given type from the given DataFormat.XML HttpEntity.

Type Parameters:

T - The expected type of the deserialized data transfer object.

Parameters:

httpEntity - The deserializable DataFormat.XML HttpEntity

type - The expected type of the deserialized data transfer object.

Returns:

The deserialized DataFormat.XML data transfer object.

Throws:

ResultException - Shall be thrown upon a deserialization failure.

fromXML

@NotNull
public static <T> T fromXML(@Nullable
                            @Nullable StreamSource streamSource,
                            @NotNull
                            @NotNull Class<T> type)
                     throws ResultException

Deserialize the data transfer object to the given type from the given DataFormat.XML StreamSource.

Type Parameters:

T - The expected type of the deserialized data transfer object.

Parameters:

streamSource - The deserializable DataFormat.XML StreamSource

type - The expected type of the deserialized data transfer object.

Returns:

The deserialized DataFormat.XML data transfer object.

Throws:

ResultException - Shall be thrown upon a deserialization failure.

fromJSON

@NotNull
public static <T> T fromJSON(@Nullable
                             @Nullable org.apache.hc.core5.http.HttpEntity httpEntity,
                             @NotNull
                             @NotNull Class<T> type)
                      throws ResultException

Deserialize the data transfer object to the given type from the given DataFormat.JSON HttpEntity.

Type Parameters:

T - The expected type of the deserialized data transfer object.

Parameters:

httpEntity - The deserializable DataFormat.JSON HttpEntity

type - The expected type of the deserialized data transfer object.

Returns:

The deserialized DataFormat.JSON data transfer object.

Throws:

ResultException - Shall be thrown upon a deserialization failure.

fromJSON

@NotNull
public static <T> T fromJSON(@Nullable
                             @Nullable StreamSource streamSource,
                             @NotNull
                             @NotNull Class<T> type)
                      throws ResultException

Deserialize the data transfer object to the given type from the given DataFormat.JSON StreamSource.

Type Parameters:

T - The expected type of the deserialized data transfer object.

Parameters:

streamSource - The deserializable DataFormat.JSON StreamSource

type - The expected type of the deserialized data transfer object.

Returns:

The deserialized DataFormat.JSON data transfer object.

Throws:

ResultException - Shall be thrown upon a deserialization failure.

toJSON

@NotNull
public static @NotNull String toJSON(@Nullable
                                     @Nullable Object object)
                              throws ResultException

Serialize a data transfer object to DataFormat.JSON

Parameters:

object - The object to serialize.

Returns:

The resulting DataFormat.JSON String.

Throws:

ResultException - Shall be thrown upon a serialization failure.

toXML

@NotNull
public static @NotNull String toXML(@Nullable
                                    @Nullable Object object,
                                    @NotNull
                                    @NotNull Class<?> type)
                             throws ResultException

Serialize a data transfer object to DataFormat.XML.

Parameters:

object - The data transfer object to serialize.

type - The annotated type of the data transfer object.

Returns:

The resulting DataFormat.XML String.

Throws:

ResultException - Shall be thrown upon a serialization failure.