Package com.structurizr.analysis

Class SourceCodeComponentFinderStrategy

java.lang.Object

com.structurizr.analysis.SourceCodeComponentFinderStrategy

All Implemented Interfaces:

ComponentFinderStrategy

public class SourceCodeComponentFinderStrategy
extends java.lang.Object
implements ComponentFinderStrategy

This component finder strategy doesn't really find components, it instead:

• Extracts the top-level Javadoc comment from the code so that this can be added to existing component definitions.
• Calculates the size of components based upon the number of lines of source code.

Constructor Summary

Constructors

Constructor	Description
SourceCodeComponentFinderStrategy(java.io.File sourcePath)
SourceCodeComponentFinderStrategy(java.io.File sourcePath, int maxDescriptionLength)

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.
void	setEncoding(java.lang.String encoding)
static boolean	start(com.sun.javadoc.RootDoc rootDoc)

Methods inherited from class java.lang.Object

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

Constructor Detail

SourceCodeComponentFinderStrategy

public SourceCodeComponentFinderStrategy(java.io.File sourcePath)

SourceCodeComponentFinderStrategy

public SourceCodeComponentFinderStrategy(java.io.File sourcePath,
                                         int maxDescriptionLength)

Method Detail

setComponentFinder

public void setComponentFinder(ComponentFinder componentFinder)

Description copied from interface: ComponentFinderStrategy

Sets a reference to the parent component finder.

Specified by:

setComponentFinder in interface ComponentFinderStrategy

Parameters:

componentFinder - a ComponentFinder instance

setEncoding

public void setEncoding(java.lang.String encoding)

beforeFindComponents

public void beforeFindComponents()
                          throws java.lang.Exception

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

Throws:

java.lang.Exception - if something goes wrong

findComponents

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

Description copied from interface: ComponentFinderStrategy

Finds components.

Specified by:

findComponents in interface ComponentFinderStrategy

Returns:

the set of components found

Throws:

java.lang.Exception - if something goes wrong

afterFindComponents

public void afterFindComponents()
                         throws java.lang.Exception

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

Throws:

java.lang.Exception - if something goes wrong

start

public static boolean start(com.sun.javadoc.RootDoc rootDoc)