Package org.archifacts.core.model

Class ApplicationBuilder

java.lang.Object

org.archifacts.core.model.ApplicationBuilder

public final class ApplicationBuilder
extends Object

Offers methods to register descriptors and is capable of building the Application by applying those descriptors. An instance of ApplicationBuilder can be obtained by calling Application.builder(). Note: Adding descriptors is not thread-safe!

Author:

Oliver Libutzki

Method Summary

Modifier and Type	Method	Description
ApplicationBuilder	addBuildingBlockDescriptor(BuildingBlockDescriptor buildingBlockDescriptor)	Registers a BuildingBlockDescriptor.
ApplicationBuilder	addContainerDescriptor(ArtifactContainerDescriptor artifactContainerDescriptor)	Registers an ArtifactContainerDescriptor.
ApplicationBuilder	addSourceBasedRelationshipDescriptor(SourceBasedArtifactRelationshipDescriptor sourceBasedArtifactRelationshipDescriptor)	Registers a SourceBasedArtifactRelationshipDescriptor.
ApplicationBuilder	addTargetBasedRelationshipDescriptor(TargetBasedArtifactRelationshipDescriptor targetBasedArtifactRelationshipDescriptor)	Registers a TargetBasedArtifactRelationshipDescriptor.
Application	buildApplication(com.tngtech.archunit.core.domain.JavaClasses javaClasses)	Build the Application by applying the descriptors.

Methods inherited from class java.lang.Object

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

Method Detail

addContainerDescriptor

public ApplicationBuilder addContainerDescriptor(ArtifactContainerDescriptor artifactContainerDescriptor)

Registers an ArtifactContainerDescriptor.

Parameters:

artifactContainerDescriptor - the descriptor to be added, cannot be null

Returns:

this instance for method-chaining

addBuildingBlockDescriptor

public ApplicationBuilder addBuildingBlockDescriptor(BuildingBlockDescriptor buildingBlockDescriptor)

Registers a BuildingBlockDescriptor.

Parameters:

buildingBlockDescriptor - the descriptor to be added, cannot be null

Returns:

this instance for method-chaining

addSourceBasedRelationshipDescriptor

public ApplicationBuilder addSourceBasedRelationshipDescriptor(SourceBasedArtifactRelationshipDescriptor sourceBasedArtifactRelationshipDescriptor)

Registers a SourceBasedArtifactRelationshipDescriptor.

Parameters:

sourceBasedArtifactRelationshipDescriptor - the descriptor to be added,

Returns:

this instance for method-chaining cannot be null

addTargetBasedRelationshipDescriptor

public ApplicationBuilder addTargetBasedRelationshipDescriptor(TargetBasedArtifactRelationshipDescriptor targetBasedArtifactRelationshipDescriptor)

Registers a TargetBasedArtifactRelationshipDescriptor.

Parameters:

targetBasedArtifactRelationshipDescriptor - the descriptor to be added,

Returns:

this instance for method-chaining cannot be null

buildApplication

public Application buildApplication(com.tngtech.archunit.core.domain.JavaClasses javaClasses)

Build the Application by applying the descriptors.

Parameters:

javaClasses - The application's scope. All the classes which are part of JavaClasses are classes which are contained in the application. Cannot be null.

Returns:

the Application