org.seedstack.business.spi.DtoInfoResolver 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.spi;

import org.seedstack.business.domain.AggregateRoot;

/**
 * Interface for classes implementing the ability to instantiate corresponding aggregates and
 * identifiers from a DTO. DTO resolvers are used by
 * {@link org.seedstack.business.assembler.dsl.FluentAssembler}
 * to create domain aggregates and/or identifiers from DTO instances.
 *
 *  There can be several {@link DtoInfoResolver}s in the system: the first one returning true
 * from the {@link #supports(Object)} for a particular DTO will be used. Implementations can be
 * annotated with {@code javax.annotation.Priority} to define an absolute order amongst them. 
 */
public interface DtoInfoResolver {

    /**
     * Returns whether the resolver supports the DTO instance passed as argument. The first resolver
     * to support a particular DTO is used.
     *
     * @param dto the DTO to check for.
     * @param  the type of the DTO.
     * @return true if the resolver supports this particular DTO, false otherwise.
     */
     boolean supports(D dto);

    /**
     * Returns the identifier instance derived from the DTO instance passed as first argument.
     *
     * @param dto              the DTO used to resolve the identifier.
     * @param aggregateIdClass the identifier class.
     * @param               the type of the DTO.
     * @param               the type of the identifier.
     * @return the newly created identifier derived from the DTO.
     */
     I resolveId(D dto, Class aggregateIdClass);

    /**
     * Similar to {@link #resolveId(Object, Class)} but used in the case where a {@link
     * org.javatuples.Tuple} of multiple aggregates corresponds to a single DTO. The position argument
     * specifies the index of the identifier in the tuple.
     *
     * @param dto              the DTO used to resolve the identifier.
     * @param aggregateIdClass the identifier class.
     * @param position         the position in the tuple of the aggregate this identifier relates to.
     * @param               the type of the DTO.
     * @param               the type of the identifier.
     * @return the newly created identifier derived from the DTO.
     */
     I resolveId(D dto, Class aggregateIdClass, int position);

    /**
     * Returns the aggregate instance derived from the DTO instance passed as first argument.
     *
     * @param dto                the DTO sued to resolve the aggregate.
     * @param aggregateRootClass the aggregate root class.
     * @param                 the type of the DTO.
     * @param                 the type of the aggregate root.
     * @return the newly created aggregate derived from the DTO.
     */
    > A resolveAggregate(D dto, Class aggregateRootClass);

    /**
     * Similar to {@link #resolveAggregate(Object, Class)} but used in the case where a {@link
     * org.javatuples.Tuple} of multiple aggregates corresponds to a single DTO. The position argument
     * specifies the index of the aggregate in the tuple.
     *
     * @param dto                the DTO sued to resolve the aggregate.
     * @param aggregateRootClass the aggregate root class.
     * @param position           the position in the tuple of the aggregate to create.
     * @param                 the type of the DTO.
     * @param                 the type of the aggregate root.
     * @return the newly created aggregate derived from the DTO.
     */
    > A resolveAggregate(D dto, Class aggregateRootClass, int position);
}