com.ibm.cos.v2.core.traits

Class LocationTrait

java.lang.Object

com.ibm.cos.v2.core.traits.LocationTrait

All Implemented Interfaces:

Trait

public final class LocationTrait
extends Object
implements Trait

Trait to include metadata about the marshalling/unmarshalling location (i.e. headers/payload/etc).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LocationTrait.Builder Builder for LocationTrait.

Method Summary

Modifier and Type	Method and Description
static LocationTrait.Builder	builder()
MarshallLocation	location()
String	locationName()
TraitType	type() The known trait type.
String	unmarshallLocationName()

Methods inherited from class java.lang.Object

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

Method Detail

location

public MarshallLocation location()

Returns:

Location of member (i.e. headers/query/path/payload).

locationName

public String locationName()

Returns:

Location name of member. I.E. the header or query param name, or the JSON field name, etc.

unmarshallLocationName

public String unmarshallLocationName()

Returns:

Location name for unmarshalling. This is only needed for the legacy EC2 protocol which has different serialization/deserialization for the same fields.

type

public TraitType type()

Description copied from interface: Trait

The known trait type. This is correctly implemented and uniquely mapped to the enum values which allow us to create enum maps for trait known trait types.

Specified by:

type in interface Trait

builder

public static LocationTrait.Builder builder()

Returns:

Builder instance.