Package org.archifacts.core.descriptor

Interface SourceBasedArtifactRelationshipDescriptor

All Superinterfaces:

ArtifactRelationshipDescriptor

public interface SourceBasedArtifactRelationshipDescriptor
extends ArtifactRelationshipDescriptor

Describes an ArtifactRelationship. As it is source-based the relationship's source side is the artifact which is able to provide all the information to build the ArtifactRelationship.

Author:

Oliver Libutzki

See Also:

ArtifactRelationship

Method Summary

Modifier and Type	Method	Description
boolean	isSource(Artifact sourceCandidateArtifact)	Evaluates if the given Artifact is the source of the described ArtifactRelationship.
Stream<com.tngtech.archunit.core.domain.JavaClass>	targets(com.tngtech.archunit.core.domain.JavaClass sourceClass)	For every Artifact which is considered to be a relationship source by isSource(Artifact), this method is called by passing Artifact.getJavaClass().

Methods inherited from interface org.archifacts.core.descriptor.ArtifactRelationshipDescriptor

role

Method Detail

isSource

boolean isSource(Artifact sourceCandidateArtifact)

Evaluates if the given Artifact is the source of the described ArtifactRelationship.

Parameters:

sourceCandidateArtifact - The Artifact to be evaluated

Returns:

true, if the given Artifact is the source of the described ArtifactRelationship, otherwise false.

targets

Stream<com.tngtech.archunit.core.domain.JavaClass> targets(com.tngtech.archunit.core.domain.JavaClass sourceClass)

For every Artifact which is considered to be a relationship source by isSource(Artifact), this method is called by passing Artifact.getJavaClass(). Returns all the targets. For each target a ArtifactRelationship is built.

Parameters:

sourceClass - the JavaClass of the Artifact for which isSource(Artifact) returned true.

Returns:

all the targets from the given JavaClass which are described by this descriptor.