org.seedstack.business.domain.Factory Maven / Gradle / Ivy
/*
* 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.domain;
/**
* A factory is responsible for creating a whole, internally consistent aggregate when it is too
* complicated to do it in a constructor.
*
* A factory is part of the domain and responsible for creating some domain objects. In the
* business framework a factory can only create domain objects implementing {@link Producible}:
* - Aggregates through their aggregate root,
- Value objects,
- Domain
* events.
Note that non-root entities are not produced by factories but should be
* created by their aggregate root.
*
* Being responsible for creating valid aggregates, factories may need to create their identity. This can be done
* from input parameters given to the factory or by using an {@link IdentityGenerator}.
*
* Example:
*
* public interface SomeFactory extends Factory<SomeAggregate> {
* SomeAggregate createFromName(String name);
* }
*
* public class SomeFactoryImpl implements SomeFactory {
* SomeAggregate createFromName(String name) {
* // create and return the aggregate
* }
* }
*
*
* @param the type of the produced object.
*/
@DomainFactory
public interface Factory
{
/**
* Returns the class produced by the factory.
*
* @return the produced class
*/
Class
getProducedClass();
/**
* Creates an object instance in a generic way, using the given arguments. How are these arguments
* used for creation is implementation-dependent.
*
* @param args the arguments for object creation.
* @return an instance of the class produced by the factory.
*/
@Create
default P create(Object... args) {
throw new UnsupportedOperationException("Generic creation is not supported by this factory");
}
}