com.structurizr.analysis

Class StructurizrAnnotationsComponentFinderStrategy

java.lang.Object

com.structurizr.analysis.AbstractComponentFinderStrategy

com.structurizr.analysis.StructurizrAnnotationsComponentFinderStrategy

All Implemented Interfaces:

ComponentFinderStrategy

public class StructurizrAnnotationsComponentFinderStrategy
extends AbstractComponentFinderStrategy

This component finder strategy looks for the following Structurizr annotations. - Definitions: @Component - Efferent dependencies: @UsesSoftwareSystem, @UsesContainer, @UsesComponent - Afferent dependencies: @UsedByPerson, @UsedBySoftwareSystem, @UsedByContainer

Field Summary

Fields inherited from class com.structurizr.analysis.AbstractComponentFinderStrategy

componentFinder, componentsFound, supportingTypesStrategies

Constructor Summary

Constructors

Constructor and Description
StructurizrAnnotationsComponentFinderStrategy()
StructurizrAnnotationsComponentFinderStrategy(SupportingTypesStrategy... strategies)

Method Summary

Modifier and Type	Method and Description
void	afterFindComponents() Called after all component finder strategies belonging to the same component finder have found components.
protected java.util.Set<com.structurizr.model.Component>	doFindComponents() A template method into which subclasses can put their component finding code.

Methods inherited from class com.structurizr.analysis.AbstractComponentFinderStrategy

addComponent, addSupportingTypesStrategy, beforeFindComponents, findClassesWithAnnotation, findClassesWithAnnotation, findComponents, findDependencies, findSupportingTypes, findTypesAnnotatedWith, getComponentFinder, getDuplicateComponentStrategy, getTypeRepository, setComponentFinder, setDuplicateComponentStrategy

Methods inherited from class java.lang.Object

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

Constructor Detail

StructurizrAnnotationsComponentFinderStrategy

public StructurizrAnnotationsComponentFinderStrategy()

StructurizrAnnotationsComponentFinderStrategy

public StructurizrAnnotationsComponentFinderStrategy(SupportingTypesStrategy... strategies)

Method Detail

doFindComponents

protected java.util.Set<com.structurizr.model.Component> doFindComponents()

Description copied from class: AbstractComponentFinderStrategy

A template method into which subclasses can put their component finding code.

Specified by:

doFindComponents in class AbstractComponentFinderStrategy

Returns:

the Set of Components found, or an empty set if no components were found

afterFindComponents

public void afterFindComponents()

Description copied from interface: ComponentFinderStrategy

Called after all component finder strategies belonging to the same component finder have found components. This can be used to supplement the component with more information, such as dependencies.

Specified by:

afterFindComponents in interface ComponentFinderStrategy

Overrides:

afterFindComponents in class AbstractComponentFinderStrategy