Package software.amazon.awssdk.core

Class SdkField<TypeT>

java.lang.Object

software.amazon.awssdk.core.SdkField<TypeT>

Type Parameters:

TypeT - Java Type of member.

public final class SdkField<TypeT>
extends Object

Metadata about a member in an SdkPojo. Contains information about how to marshall/unmarshall.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SdkField.Builder<TypeT>	Builder for SdkField.

Method Summary

Modifier and Type	Method	Description
static <TypeT> SdkField.Builder<TypeT>	builder(MarshallingType<? super TypeT> marshallingType)	Creates a new instance of SdkField.Builder bound to the specified type.
Supplier<SdkPojo>	constructor()
boolean	containsTrait(Class<? extends Trait> clzz)	Checks if a given Trait is present on the field.
boolean	containsTrait(Class<? extends Trait> clzz, TraitType type)	Checks if a given Trait is present on the field.
<T extends Trait> Optional<T>	getOptionalTrait(Class<T> clzz)	Gets the trait of the specified class if available.
<T extends Trait> Optional<T>	getOptionalTrait(Class<T> clzz, TraitType type)	Gets the trait of the specified class if available.
<T extends Trait> T	getRequiredTrait(Class<T> clzz)	Gets the trait of the specified class, or throw IllegalStateException if not available.
<T extends Trait> T	getRequiredTrait(Class<T> clzz, TraitType type)	Gets the trait of the specified class, or throw IllegalStateException if not available.
<T extends Trait> T	getTrait(Class<T> clzz)	Gets the trait of the specified class if available.
<T extends Trait> T	getTrait(Class<T> clzz, TraitType type)	Gets the trait of the specified class and known type if available.
TypeT	getValueOrDefault(Object pojo)	Retrieves the current value of 'this' field from the given POJO.
boolean	ignoreDataTypeConversionFailures()
MarshallLocation	location()
String	locationName()
MarshallingType<? super TypeT>	marshallingType()
String	memberName()
void	set(Object pojo, Object val)	Sets the given value on the POJO via the setter passed into the SdkField.Builder.
String	unmarshallLocationName()

Methods inherited from class java.lang.Object

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

Method Detail

memberName

public String memberName()

marshallingType

public MarshallingType<? super TypeT> marshallingType()

Returns:

MarshallingType of member. Used primarily for marshaller/unmarshaller lookups.

location

public MarshallLocation location()

Returns:

Location the member should be marshalled into (i.e. headers/query/path/payload).

locationName

public String locationName()

Returns:

The location name to use when marshalling. I.E. the field name of the JSON document, or the header name, etc.

ignoreDataTypeConversionFailures

public boolean ignoreDataTypeConversionFailures()

Returns:

whether data-type conversion errors are to be ignored

unmarshallLocationName

public String unmarshallLocationName()

Returns:

The location name to use when unmarshalling. This is only needed for AWS/Query or EC2 services. All other services should use locationName for both marshalling and unmarshalling.

constructor

public Supplier<SdkPojo> constructor()

getTrait

public <T extends Trait> T getTrait(Class<T> clzz)

Gets the trait of the specified class if available.

Type Parameters:

T - Type of trait.

Parameters:

clzz - Trait class to get.

Returns:

Trait instance or null if trait is not present.

getTrait

public <T extends Trait> T getTrait(Class<T> clzz,
                                    TraitType type)

Gets the trait of the specified class and known type if available.

Type Parameters:

T - Type of trait.

Parameters:

clzz - Trait class to get.

type - The TraitType for this trait.

Returns:

Trait instance or null if trait is not present.

getOptionalTrait

public <T extends Trait> Optional<T> getOptionalTrait(Class<T> clzz)

Gets the trait of the specified class if available.

Type Parameters:

T - Type of trait.

Parameters:

clzz - Trait class to get.

Returns:

Optional of trait instance.

getOptionalTrait

public <T extends Trait> Optional<T> getOptionalTrait(Class<T> clzz,
                                                      TraitType type)

Gets the trait of the specified class if available.

Type Parameters:

T - Type of trait.

Parameters:

clzz - Trait class to get.

type - The TraitType for this trait.

Returns:

Optional of trait instance.

getRequiredTrait

public <T extends Trait> T getRequiredTrait(Class<T> clzz)
                                     throws IllegalStateException

Gets the trait of the specified class, or throw IllegalStateException if not available.

Type Parameters:

T - Type of trait.

Parameters:

clzz - Trait class to get.

Returns:

Trait instance.

Throws:

IllegalStateException - if trait is not present.

getRequiredTrait

public <T extends Trait> T getRequiredTrait(Class<T> clzz,
                                            TraitType type)
                                     throws IllegalStateException

Gets the trait of the specified class, or throw IllegalStateException if not available.

Type Parameters:

T - Type of trait.

Parameters:

clzz - Trait class to get.

type - The TraitType for this trait.

Returns:

Trait instance.

Throws:

IllegalStateException - if trait is not present.

containsTrait

public boolean containsTrait(Class<? extends Trait> clzz)

Checks if a given Trait is present on the field.

Parameters:

clzz - Trait class to check.

Returns:

True if trait is present, false if not.

containsTrait

public boolean containsTrait(Class<? extends Trait> clzz,
                             TraitType type)

Checks if a given Trait is present on the field.

Parameters:

clzz - Trait class to check.

type - The TraitType for this trait.

Returns:

True if trait is present, false if not.

getValueOrDefault

public TypeT getValueOrDefault(Object pojo)

Retrieves the current value of 'this' field from the given POJO. Uses the getter passed into the SdkField.Builder. If the current value is null this method will look for the DefaultValueTrait on the field and attempt to resolve a default value. If the DefaultValueTrait is not present this just returns null.

Parameters:

pojo - POJO to retrieve value from.

Returns:

Current value of 'this' field in the POJO or default value if current value is null.

set

public void set(Object pojo,
                Object val)

Sets the given value on the POJO via the setter passed into the SdkField.Builder.

Parameters:

pojo - POJO containing field to set.

val - Value of field.

builder

public static <TypeT> SdkField.Builder<TypeT> builder(MarshallingType<? super TypeT> marshallingType)

Creates a new instance of SdkField.Builder bound to the specified type.

Type Parameters:

TypeT - Type of field. Must be a subtype of the MarshallingType type param.

Parameters:

marshallingType - Type of field.

Returns:

New builder instance.