Package com.structurizr.analysis

Class AbstractComponentFinderStrategy

java.lang.Object

com.structurizr.analysis.AbstractComponentFinderStrategy

All Implemented Interfaces:

ComponentFinderStrategy

Direct Known Subclasses:

StructurizrAnnotationsComponentFinderStrategy, TypeMatcherComponentFinderStrategy

public abstract class AbstractComponentFinderStrategy
extends java.lang.Object
implements ComponentFinderStrategy

This is the superclass for a number of component finder strategies.

Field Summary

Fields

Modifier and Type	Field	Description
protected ComponentFinder	componentFinder
protected java.util.List<SupportingTypesStrategy>	supportingTypesStrategies

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractComponentFinderStrategy(SupportingTypesStrategy... strategies)

Method Summary

Modifier and Type	Method	Description
protected com.structurizr.model.Component	addComponent(com.structurizr.model.Container container, java.lang.String name, java.lang.String type, java.lang.String description, java.lang.String technology)
void	addSupportingTypesStrategy(SupportingTypesStrategy supportingTypesStrategy)	Adds a supporting type strategy to this component finder strategy.
void	afterFindComponents()	Called after all component finder strategies belonging to the same component finder have found components.
void	beforeFindComponents()	Called before all component finder strategies belonging to the same component finder are asked to find components.
protected abstract java.util.Set<com.structurizr.model.Component>	doFindComponents()	A template method into which subclasses can put their component finding code.
protected java.util.Set<com.structurizr.model.Component>	findClassesWithAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> type, java.lang.String technology)
protected java.util.Set<com.structurizr.model.Component>	findClassesWithAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> type, java.lang.String technology, boolean includePublicTypesOnly)
java.util.Set<com.structurizr.model.Component>	findComponents()	Finds components.
protected java.util.Set<java.lang.Class<?>>	findTypesAnnotatedWith(java.lang.Class<? extends java.lang.annotation.Annotation> annotation)
protected ComponentFinder	getComponentFinder()
protected TypeRepository	getTypeRepository()
void	setComponentFinder(ComponentFinder componentFinder)	Sets a reference to the parent component finder.
void	setDuplicateComponentStrategy(DuplicateComponentStrategy duplicateComponentStrategy)

Methods inherited from class java.lang.Object

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

Field Detail

componentFinder

protected ComponentFinder componentFinder

supportingTypesStrategies

protected java.util.List<SupportingTypesStrategy> supportingTypesStrategies

Constructor Detail

AbstractComponentFinderStrategy

protected AbstractComponentFinderStrategy(SupportingTypesStrategy... strategies)

Method Detail

getComponentFinder

protected ComponentFinder getComponentFinder()

setComponentFinder

public void setComponentFinder(ComponentFinder componentFinder)

Sets a reference to the parent component finder.

Specified by:

setComponentFinder in interface ComponentFinderStrategy

Parameters:

componentFinder - a ComponentFinder instance

getTypeRepository

protected TypeRepository getTypeRepository()

beforeFindComponents

public void beforeFindComponents()

Description copied from interface: ComponentFinderStrategy

Called before all component finder strategies belonging to the same component finder are asked to find components.

Specified by:

beforeFindComponents in interface ComponentFinderStrategy

findComponents

public java.util.Set<com.structurizr.model.Component> findComponents()

Description copied from interface: ComponentFinderStrategy

Finds components.

Specified by:

findComponents in interface ComponentFinderStrategy

Returns:

the set of components found

doFindComponents

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

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

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

addSupportingTypesStrategy

public void addSupportingTypesStrategy(SupportingTypesStrategy supportingTypesStrategy)

Adds a supporting type strategy to this component finder strategy.

Parameters:

supportingTypesStrategy - a SupportingTypesStrategy instance

findTypesAnnotatedWith

protected java.util.Set<java.lang.Class<?>> findTypesAnnotatedWith(java.lang.Class<? extends java.lang.annotation.Annotation> annotation)

findClassesWithAnnotation

protected java.util.Set<com.structurizr.model.Component> findClassesWithAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> type,
                                                                                   java.lang.String technology)

findClassesWithAnnotation

protected java.util.Set<com.structurizr.model.Component> findClassesWithAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> type,
                                                                                   java.lang.String technology,
                                                                                   boolean includePublicTypesOnly)

setDuplicateComponentStrategy

public void setDuplicateComponentStrategy(DuplicateComponentStrategy duplicateComponentStrategy)

addComponent

protected com.structurizr.model.Component addComponent(com.structurizr.model.Container container,
                                                       java.lang.String name,
                                                       java.lang.String type,
                                                       java.lang.String description,
                                                       java.lang.String technology)