com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBFlattened Maven / Gradle / Ivy
/*
* Copyright 2016-2021 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.
* You may obtain a copy of the License at:
*
* http://aws.amazon.com/apache2.0
*
* 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 com.amazonaws.services.dynamodbv2.datamodeling;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Annotation for flattening a complex type.
*
*
* @DynamoDBFlattened(attributes={
* @DynamoDBAttribute(mappedBy="start", attributeName="effectiveStartDate"),
* @DynamoDBAttribute(mappedBy="end", attributeName="effectiveEndDate")})
* public DateRange getEffectiveRange() { return effectiveRange; }
* public void setEffectiveRange(DateRange effectiveRange) { this.effectiveRange = effectiveRange; }
*
* @DynamoDBFlattened(attributes={
* @DynamoDBAttribute(mappedBy="start", attributeName="extensionStartDate"),
* @DynamoDBAttribute(mappedBy="end", attributeName="extensionEndDate")})
* public DateRange getExtensionRange() { return extensionRange; }
* public void setExtensionRange(DateRange extensionRange) { this.extensionRange = extensionRange; }
*
*
* Where,
*
* public class DateRange {
* private Date start;
* private Date end;
*
* public Date getStart() { return start; }
* public void setStart(Date start) { this.start = start; }
*
* public Date getEnd() { return end; }
* public void setEnd(Date end) { this.end = end; }
* }
*
*
* Attributes defined within the complex type may also be annotated.
*
* May be used as a meta-annotation.
*/
@DynamoDB
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.FIELD, ElementType.METHOD, ElementType.ANNOTATION_TYPE})
public @interface DynamoDBFlattened {
/**
* Indicates the attributes that should be flattened.
*/
DynamoDBAttribute[] attributes() default {};
}