org.jmolecules.archunit

Class JMoleculesRules

java.lang.Object

org.jmolecules.archunit.JMoleculesRules

public class JMoleculesRules
extends Object

A set of ArchUnit rules that allow verification of domain models. In short the rules here verify:

• Aggregates only refer to entities that are declared to be part of it.
• References to other aggregates are established via Associations or identifier references.

Those rules are mostly driven by what's been presented by John Sullivan in his blog post here.

Author:

Oliver Drotbohm

See Also:

http://scabl.blogspot.com/2015/04/aeddd-9.html

Constructor Summary

Constructors

Constructor and Description
JMoleculesRules()

Method Summary

Modifier and Type	Method and Description
static com.tngtech.archunit.lang.ArchRule	aggregateReferencesShouldBeViaIdOrAssociation() An ArchRule that ensures that one AggregateRoot does not reference another via the remote AggregateRoot type but rather via their identifier type or an explicit Association type.
static com.tngtech.archunit.lang.ArchRule	all() An ArchRule that's composed of all other rules declared in this class.
static com.tngtech.archunit.lang.ArchRule	entitiesShouldBeDeclaredForUseInSameAggregate() An ArchRule that verifies that fields that implement Entity within a type implementing AggregateRoot declare the aggregate type as the owning aggregate.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JMoleculesRules

public JMoleculesRules()

Method Detail

all

public static com.tngtech.archunit.lang.ArchRule all()

An ArchRule that's composed of all other rules declared in this class.

Returns:

See Also:

entitiesShouldBeDeclaredForUseInSameAggregate(), aggregateReferencesShouldBeViaIdOrAssociation()

entitiesShouldBeDeclaredForUseInSameAggregate

public static com.tngtech.archunit.lang.ArchRule entitiesShouldBeDeclaredForUseInSameAggregate()

An ArchRule that verifies that fields that implement Entity within a type implementing AggregateRoot declare the aggregate type as the owning aggregate.

class Customer implements AggregateRoot { … } class Address implements Entity { … } class LineItem implements Entity { … } class Order implements AggregateRoot { List lineItems; // valid Address shippingAddress; // invalid as Address is declared to belong to Customer }

Returns:

will never be null.

aggregateReferencesShouldBeViaIdOrAssociation

public static com.tngtech.archunit.lang.ArchRule aggregateReferencesShouldBeViaIdOrAssociation()

An ArchRule that ensures that one AggregateRoot does not reference another via the remote AggregateRoot type but rather via their identifier type or an explicit Association type.

class Customer implements AggregateRoot { … } class Order implements AggregateRoot { Customer customer; // invalid CustomerId customerId; // valid Association customer; // valid }

Returns:

will never be null.