com.ibm.cloud.objectstorage.protocol.json

Class JsonProtocolMarshallerBuilder<T>

java.lang.Object

com.ibm.cloud.objectstorage.protocol.json.JsonProtocolMarshallerBuilder<T>

Type Parameters:

T - Type of the original request object.

public class JsonProtocolMarshallerBuilder<T>
extends Object

Builder to create an appropriate implementation of ProtocolMarshaller for JSON based services.

Constructor Summary

Constructors

Constructor and Description
JsonProtocolMarshallerBuilder()

Method Summary

Modifier and Type	Method and Description
ProtocolRequestMarshaller<T>	build()
JsonProtocolMarshallerBuilder<T>	contentType(String contentType)
JsonProtocolMarshallerBuilder<T>	emptyBodyMarshaller(EmptyBodyJsonMarshaller emptyBodyMarshaller) Sets the marshaller to use when a request contains an explicit member but that member is null.
JsonProtocolMarshallerBuilder<T>	jsonGenerator(StructuredJsonGenerator jsonGenerator)
<MarshallT> JsonProtocolMarshallerBuilder<T>	marshallerOverride(MarshallLocation marshallLocation, MarshallingType<MarshallT> marshallingType, StructuredJsonMarshaller<MarshallT> marshaller) Registers an override for the marshaller registry.
JsonProtocolMarshallerBuilder<T>	operationInfo(OperationInfo operationInfo)
JsonProtocolMarshallerBuilder<T>	originalRequest(T originalRequest)
JsonProtocolMarshallerBuilder<T>	sendExplicitNullForPayload(boolean sendExplicitNullForPayload) Deprecated.
static <T> JsonProtocolMarshallerBuilder<T>	standard()

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonProtocolMarshallerBuilder

public JsonProtocolMarshallerBuilder()

Method Detail

standard

public static <T> JsonProtocolMarshallerBuilder<T> standard()

jsonGenerator

public JsonProtocolMarshallerBuilder<T> jsonGenerator(StructuredJsonGenerator jsonGenerator)

contentType

public JsonProtocolMarshallerBuilder<T> contentType(String contentType)

operationInfo

public JsonProtocolMarshallerBuilder<T> operationInfo(OperationInfo operationInfo)

originalRequest

public JsonProtocolMarshallerBuilder<T> originalRequest(T originalRequest)

sendExplicitNullForPayload

@Deprecated
public JsonProtocolMarshallerBuilder<T> sendExplicitNullForPayload(boolean sendExplicitNullForPayload)

Deprecated.

Has been used to direct whether an explicit JSON null should be sent as the body when the payload member is null, but now does nothing. Deprecated in favor of directly supplying a marshaller for empty bodies.

See Also:

JsonProtocolMarshallerBuilder.emptyBodyMarshaller(EmptyBodyJsonMarshaller)

emptyBodyMarshaller

public JsonProtocolMarshallerBuilder<T> emptyBodyMarshaller(EmptyBodyJsonMarshaller emptyBodyMarshaller)

Sets the marshaller to use when a request contains an explicit member but that member is null.

Parameters:

emptyBodyMarshaller - An empty body marshaller

Returns:

This builder for method chaining

marshallerOverride

public <MarshallT> JsonProtocolMarshallerBuilder<T> marshallerOverride(MarshallLocation marshallLocation,
                                                                       MarshallingType<MarshallT> marshallingType,
                                                                       StructuredJsonMarshaller<MarshallT> marshaller)

Registers an override for the marshaller registry.

Type Parameters:

MarshallT - Type of thing being marshalled.

Parameters:

marshallLocation - Location to override marshaller for.

marshallingType - Type to override marshaller for.

marshaller - Marshaller to use for the given location and type.

Returns:

This builder for method chaining.

build

public ProtocolRequestMarshaller<T> build()