software.amazon.awssdk.core.SdkField Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of sdk-core Show documentation
Show all versions of sdk-core Show documentation
The AWS SDK for Java - SDK Core runtime module holds the classes that are used by the individual service
clients to interact with
Amazon Web Services. Users need to depend on aws-java-sdk artifact for accessing individual client classes.
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package software.amazon.awssdk.core;
import java.util.Arrays;
import java.util.EnumMap;
import java.util.HashMap;
import java.util.Map;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import java.util.function.Supplier;
import software.amazon.awssdk.annotations.SdkProtectedApi;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.DataTypeConversionFailureHandlingTrait;
import software.amazon.awssdk.core.traits.DefaultValueTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.traits.Trait;
import software.amazon.awssdk.core.traits.TraitType;
/**
* Metadata about a member in an {@link SdkPojo}. Contains information about how to marshall/unmarshall.
*
* @param Java Type of member.
*/
@SdkProtectedApi
public final class SdkField {
private final String memberName;
private final MarshallingType marshallingType;
private final MarshallLocation location;
private final String locationName;
private final String unmarshallLocationName;
private final Supplier constructor;
private final BiConsumer setter;
private final Function getter;
private final Map l1Traits;
private final Map, Trait> l2Traits;
private SdkField(Builder builder) {
this.memberName = builder.memberName;
this.marshallingType = builder.marshallingType;
this.l1Traits = createL1Traits(builder.traits);
this.l2Traits = createL2Traits(builder.traits);
this.constructor = builder.constructor;
this.setter = builder.setter;
this.getter = builder.getter;
// Eagerly dereference location trait since it's so commonly used.
LocationTrait locationTrait = getTrait(LocationTrait.class, TraitType.LOCATION_TRAIT);
this.location = locationTrait.location();
this.locationName = locationTrait.locationName();
this.unmarshallLocationName = locationTrait.unmarshallLocationName();
}
/**
* Creates an L1 traits map. This map is for fast lookup of known traits.
*/
private static Map createL1Traits(Map, Trait> traits) {
Map result = new EnumMap<>(TraitType.class);
for (Map.Entry, Trait> kvp : traits.entrySet()) {
Trait trait = kvp.getValue();
TraitType type = trait.type();
if (type != null) {
result.put(type, trait);
}
}
return result;
}
/**
* Creates an L2 traits map. This map is for regular lookup of unknown traits.
*/
private static Map, Trait> createL2Traits(Map, Trait> traits) {
Map, Trait> result = new HashMap<>();
for (Map.Entry, Trait> kvp : traits.entrySet()) {
Trait trait = kvp.getValue();
TraitType type = trait.type();
if (type == null) {
result.put(kvp.getKey(), trait);
}
}
return result;
}
public String memberName() {
return memberName;
}
/**
* @return MarshallingType of member. Used primarily for marshaller/unmarshaller lookups.
*/
public MarshallingType marshallingType() {
return marshallingType;
}
/**
* @return Location the member should be marshalled into (i.e. headers/query/path/payload).
*/
public MarshallLocation location() {
return location;
}
/**
* @return The location name to use when marshalling. I.E. the field name of the JSON document, or the header name, etc.
*/
public String locationName() {
return locationName;
}
/**
* @return whether data-type conversion errors are to be ignored
*/
public boolean ignoreDataTypeConversionFailures() {
DataTypeConversionFailureHandlingTrait dataTypeConversionFailureHandlingTrait =
getTrait(DataTypeConversionFailureHandlingTrait.class, TraitType.DATA_TYPE_CONVERSION_FAILURE_HANDLING_TRAIT);
return dataTypeConversionFailureHandlingTrait != null;
}
/**
* @return The location name to use when unmarshalling. This is only needed for AWS/Query or EC2 services. All
* other services should use {@link #locationName} for both marshalling and unmarshalling.
*/
public String unmarshallLocationName() {
return unmarshallLocationName;
}
public Supplier constructor() {
return constructor;
}
/**
* Gets the trait of the specified class if available.
*
* @param clzz Trait class to get.
* @param Type of trait.
* @return Trait instance or null if trait is not present.
*/
@SuppressWarnings("unchecked")
public T getTrait(Class clzz) {
TraitType type = TraitType.from(clzz);
if (type != null) {
return (T) l1Traits.get(type);
}
return (T) l2Traits.get(clzz);
}
/**
* Gets the trait of the specified class and known type if available.
*
* @param clzz Trait class to get.
* @param type The {@link TraitType} for this trait.
* @param Type of trait.
* @return Trait instance or null if trait is not present.
*/
@SuppressWarnings("unchecked")
public T getTrait(Class clzz, TraitType type) {
return (T) l1Traits.get(type);
}
/**
* Gets the trait of the specified class if available.
*
* @param clzz Trait class to get.
* @param Type of trait.
* @return Optional of trait instance.
*/
@SuppressWarnings("unchecked")
public Optional getOptionalTrait(Class clzz) {
return Optional.ofNullable((T) getTrait(clzz));
}
/**
* Gets the trait of the specified class if available.
*
* @param clzz Trait class to get.
* @param Type of trait.
* @param type The {@link TraitType} for this trait.
* @return Optional of trait instance.
*/
@SuppressWarnings("unchecked")
public Optional getOptionalTrait(Class clzz, TraitType type) {
return Optional.ofNullable((T) getTrait(clzz, type));
}
/**
* Gets the trait of the specified class, or throw {@link IllegalStateException} if not available.
*
* @param clzz Trait class to get.
* @param Type of trait.
* @return Trait instance.
* @throws IllegalStateException if trait is not present.
*/
@SuppressWarnings("unchecked")
public T getRequiredTrait(Class clzz) throws IllegalStateException {
T trait = (T) getTrait(clzz);
if (trait == null) {
throw new IllegalStateException(memberName + " member is missing " + clzz.getSimpleName());
}
return trait;
}
/**
* Gets the trait of the specified class, or throw {@link IllegalStateException} if not available.
*
* @param clzz Trait class to get.
* @param Type of trait.
* @param type The {@link TraitType} for this trait.
* @return Trait instance.
* @throws IllegalStateException if trait is not present.
*/
@SuppressWarnings("unchecked")
public T getRequiredTrait(Class clzz, TraitType type) throws IllegalStateException {
T trait = (T) getTrait(clzz, type);
if (trait == null) {
throw new IllegalStateException(memberName + " member is missing " + clzz.getSimpleName());
}
return trait;
}
/**
* Checks if a given {@link Trait} is present on the field.
*
* @param clzz Trait class to check.
* @return True if trait is present, false if not.
*/
public boolean containsTrait(Class clzz) {
return getTrait(clzz) != null;
}
/**
* Checks if a given {@link Trait} is present on the field.
*
* @param clzz Trait class to check.
* @param type The {@link TraitType} for this trait.
* @return True if trait is present, false if not.
*/
public boolean containsTrait(Class clzz, TraitType type) {
return getTrait(clzz, type) != null;
}
/**
* Retrieves the current value of 'this' field from the given POJO. Uses the getter passed into the {@link Builder}.
*
* @param pojo POJO to retrieve value from.
* @return Current value of 'this' field in the POJO.
*/
private TypeT get(Object pojo) {
return getter.apply(pojo);
}
/**
* Retrieves the current value of 'this' field from the given POJO. Uses the getter passed into the {@link Builder}. If the
* current value is null this method will look for the {@link DefaultValueTrait} on the field and attempt to resolve a default
* value. If the {@link DefaultValueTrait} is not present this just returns null.
*
* @param pojo POJO to retrieve value from.
* @return Current value of 'this' field in the POJO or default value if current value is null.
*/
public TypeT getValueOrDefault(Object pojo) {
TypeT val = this.get(pojo);
DefaultValueTrait trait = getTrait(DefaultValueTrait.class, TraitType.DEFAULT_VALUE_TRAIT);
return (trait == null ? val : (TypeT) trait.resolveValue(val));
}
/**
* Sets the given value on the POJO via the setter passed into the {@link Builder}.
*
* @param pojo POJO containing field to set.
* @param val Value of field.
*/
@SuppressWarnings("unchecked")
public void set(Object pojo, Object val) {
setter.accept(pojo, (TypeT) val);
}
/**
* Creates a new instance of {@link Builder} bound to the specified type.
*
* @param marshallingType Type of field.
* @param Type of field. Must be a subtype of the {@link MarshallingType} type param.
* @return New builder instance.
*/
public static Builder builder(MarshallingType marshallingType) {
return new Builder<>(marshallingType);
}
/**
* Builder for {@link SdkField}.
*
* @param Java type of field.
*/
public static final class Builder {
private final MarshallingType marshallingType;
private String memberName;
private Supplier constructor;
private BiConsumer setter;
private Function getter;
private final Map, Trait> traits = new HashMap<>();
private Builder(MarshallingType marshallingType) {
this.marshallingType = marshallingType;
}
public Builder memberName(String memberName) {
this.memberName = memberName;
return this;
}
/**
* Sets a {@link Supplier} which will create a new MUTABLE instance of the POJO. I.E. this will
* create the Builder for a given POJO and not the immutable POJO itself.
*
* @param constructor Supplier method to create the mutable POJO.
* @return This object for method chaining.
*/
public Builder constructor(Supplier constructor) {
this.constructor = constructor;
return this;
}
/**
* Sets the {@link BiConsumer} which will accept an object and a value and set that value on the appropriate
* member of the object. This requires a MUTABLE pojo so thus this setter will be on the Builder
* for the given POJO.
*
* @param setter Setter method.
* @return This object for method chaining.
*/
public Builder setter(BiConsumer setter) {
this.setter = setter;
return this;
}
/**
* Sets the {@link Function} that will accept an object and return the current value of 'this' field on that object.
* This will typically be a getter on the immutable representation of the POJO and is used mostly during marshalling.
*
* @param getter Getter method.
* @return This object for method chaining.
*/
public Builder getter(Function getter) {
this.getter = getter;
return this;
}
/**
* Attaches one or more traits to the {@link SdkField}. Traits can have additional metadata and behavior that
* influence how a field is marshalled/unmarshalled.
*
* @param traits Traits to attach.
* @return This object for method chaining.
*/
public Builder traits(Trait... traits) {
Arrays.stream(traits).forEach(t -> this.traits.put(t.getClass(), t));
return this;
}
/**
* @return An immutable {@link SdkField}.
*/
public SdkField build() {
return new SdkField<>(this);
}
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy