com.ibm.cloud.objectstorage.protocol

Class MarshallingInfo<T>

java.lang.Object

com.ibm.cloud.objectstorage.protocol.MarshallingInfo<T>

public class MarshallingInfo<T>
extends Object

Metadata about the marshalling requirements of a given member. Includes things like where to put the data (payload, query, etc), the location name it's bound to (JSON field name, query param name, etc) and additional directives about how to transform it (i.e. is it binary data, should it be auto generated, etc).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MarshallingInfo.Builder<T> Builder for a MarshallingInfo.

Method Summary

Modifier and Type	Method and Description
static <T> MarshallingInfo.Builder<T>	builder(MarshallingType<T> marshallingType)
DefaultValueSupplier<T>	defaultValueSupplier()
boolean	isBinary()
boolean	isExplicitPayloadMember()
MarshallingType<T>	marshallingType()
MarshallLocation	marshallLocation()
String	marshallLocationName()
TimestampFormat	timestampFormat()

Methods inherited from class java.lang.Object

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

Method Detail

marshallingType

public MarshallingType<T> marshallingType()

Returns:

MarshallingType for this member.

marshallLocationName

public String marshallLocationName()

Returns:

Marshall location name. This may represent different things depending on where the data is meant to be marshalled to. For data bound to the payload, this may be the JSON field name, for data bound to the query params this will be the parameter name, for data bound to the path this will be the value of the path placeholder to replace in the request URI. Note that it may be null for explicit payload members.

marshallLocation

public MarshallLocation marshallLocation()

Returns:

Where the data should be marshalled to.

isExplicitPayloadMember

public boolean isExplicitPayloadMember()

Returns:

True if the member is explicitly bound to the payload. Applicable only for RESTFUL services.

isBinary

public boolean isBinary()

Returns:

True if the payload member is binary data (i.e. a ByteBuffer or InputStream and should be sent as the request content. This is not true when binary data is bound to a member of the JSON payload since it will be base64 encoded as a string.

defaultValueSupplier

public DefaultValueSupplier<T> defaultValueSupplier()

Returns:

Optional supplier of default value if the value to marshall is null.

timestampFormat

public TimestampFormat timestampFormat()

Returns:

Optional timestampFormat if the value type is date

builder

public static <T> MarshallingInfo.Builder<T> builder(MarshallingType<T> marshallingType)

Returns:

Builder instance to construct a MarshallingInfo.