Package com.structurizr.analysis

Interface ComponentFinderStrategy

All Known Implementing Classes:

AbstractComponentFinderStrategy, SourceCodeComponentFinderStrategy, StructurizrAnnotationsComponentFinderStrategy, TypeMatcherComponentFinderStrategy

public interface ComponentFinderStrategy

The interface that all component finder strategies must implement.

Method Summary

Modifier and Type	Method	Description
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.
java.util.Set<com.structurizr.model.Component>	findComponents()	Finds components.
void	setComponentFinder(ComponentFinder componentFinder)	Sets a reference to the parent component finder.

Method Detail

setComponentFinder

void setComponentFinder(ComponentFinder componentFinder)

Sets a reference to the parent component finder.

Parameters:

componentFinder - a ComponentFinder instance

beforeFindComponents

void beforeFindComponents()
                   throws java.lang.Exception

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

Throws:

java.lang.Exception - if something goes wrong

findComponents

java.util.Set<com.structurizr.model.Component> findComponents()
                                                       throws java.lang.Exception

Finds components.

Returns:

the set of components found

Throws:

java.lang.Exception - if something goes wrong

afterFindComponents

void afterFindComponents()
                  throws java.lang.Exception

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.

Throws:

java.lang.Exception - if something goes wrong