org.seedstack.business.assembler.DtoOf Maven / Gradle / Ivy

Go to download
/*
 * Copyright © 2013-2024, The SeedStack authors 
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
package org.seedstack.business.assembler;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.seedstack.business.domain.AggregateRoot;

/**
 * This annotation allows to declare a relation between a class acting as DTO and the aggregate (or
 * tuple of aggregates) it represents. It is only required by the business framework if you don't
 * have an explicit {@link Assembler} implementation for the types involved, as it allows it to
 * generate a default generic implementation.  Usage: 
 *  * {@literal @}DtoOf(Customer.class)
 *  public class CustomerDto {
 *      ...
 *  }
 * 
 *
 *  Depending upon the assembler default implementation(s) present in the classpath, a generic
 * assembler can be injected with a qualified {@link Assembler} interface: 
 *  * public class SomeClass {
 *    {@literal @}Inject
 *    {@literal @}SomeQualifier
 *     Assembler{@literal } customerAssembler;
 * }
 * 
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.ANNOTATION_TYPE})
public @interface DtoOf {

    /**
     * @return the aggregate classes needed to assemble this dto
     */
    Class>[] value();
}