Package org.archifacts.core.descriptor

Interface TargetBasedArtifactRelationshipDescriptor

All Superinterfaces:

ArtifactRelationshipDescriptor, Descriptor

public interface TargetBasedArtifactRelationshipDescriptor
extends ArtifactRelationshipDescriptor

Describes an ArtifactRelationship. As it is target-based the relationship's target 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	isTarget(Artifact targetCandidateArtifact)	Evaluates if the given Artifact is the target of the described ArtifactRelationship.
Stream<com.tngtech.archunit.core.domain.JavaClass>	sources(com.tngtech.archunit.core.domain.JavaClass targetClass)	For every Artifact which is considered to be a relationship source by isTarget(Artifact), this method is called by passing Artifact.getJavaClass().

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

role

Method Detail

isTarget

boolean isTarget(Artifact targetCandidateArtifact)

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

Parameters:

targetCandidateArtifact - The Artifact to be evaluated

Returns:

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

sources

Stream<com.tngtech.archunit.core.domain.JavaClass> sources(com.tngtech.archunit.core.domain.JavaClass targetClass)

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

Parameters:

targetClass - the JavaClass of the Artifact for which isTarget(Artifact) returned true.

Returns:

all the sources for the given JavaClass which are described by this descriptor.