Package com.structurizr.analysis

Class ComponentFinder

java.lang.Object

com.structurizr.analysis.ComponentFinder

public class ComponentFinder
extends java.lang.Object

This class allows you to find components in a Java codebase, when used in conjunction with a number of pluggable component finder strategies.

Constructor Summary

Constructors

Constructor	Description
ComponentFinder(com.structurizr.model.Container container, java.lang.String packageName, ComponentFinderStrategy... componentFinderStrategies)	Create a new component finder.

Method Summary

Modifier and Type	Method	Description
void	addPackageName(java.lang.String packageName)	Adds a package name to be scanned.
void	clearExclusions()	Clears the set of exclusions.
void	exclude(java.lang.String... regexes)	Adds one or more regexes to the set of regexes that define which types should be excluded during the component finding process.
java.util.Set<com.structurizr.model.Component>	findComponents()	Find components, using all of the configured component finder strategies in the order they were added.
com.structurizr.model.Container	getContainer()	Gets the Container that components will be added to.
java.util.Set<java.util.regex.Pattern>	getExclusions()	Gets the set of regexes that define which types should be excluded during the component finding process.
java.util.List<java.lang.String>	getPackageNames()	Gets the names of the packages to be scanned.
TypeRepository	getTypeRepository()	Gets the type repository used to analyse java classes.
java.net.URLClassLoader	getUrlClassLoader()	Gets the classloader used to load classes.
void	setTypeRepository(TypeRepository typeRepository)	Sets the type repository used to analyse java classes.
void	setUrlClassLoader(java.net.URLClassLoader urlClassLoader)	Sets a classloader to load classes from instead of the system classloader.

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentFinder

public ComponentFinder(com.structurizr.model.Container container,
                       java.lang.String packageName,
                       ComponentFinderStrategy... componentFinderStrategies)

Create a new component finder.

Parameters:

container - the Container that components will be added to

packageName - the Java package name to be scanned (e.g. "com.mycompany.myapp")

componentFinderStrategies - one or more ComponentFinderStrategy objects, describing how to find components

Method Detail

findComponents

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

Find components, using all of the configured component finder strategies in the order they were added.

Returns:

the set of Components that were found

Throws:

java.lang.Exception - if something goes wrong

getContainer

public com.structurizr.model.Container getContainer()

Gets the Container that components will be added to.

Returns:

a Container instance

addPackageName

public void addPackageName(java.lang.String packageName)

Adds a package name to be scanned.

Parameters:

packageName - the package name as a String

getPackageNames

public java.util.List<java.lang.String> getPackageNames()

Gets the names of the packages to be scanned.

Returns:

the package names, as a List of String

getExclusions

public java.util.Set<java.util.regex.Pattern> getExclusions()

Gets the set of regexes that define which types should be excluded during the component finding process.

Returns:

a set of Pattern (regex) instances

exclude

public void exclude(java.lang.String... regexes)

Adds one or more regexes to the set of regexes that define which types should be excluded during the component finding process.

Parameters:

regexes - one or more regular expressions, as Strings

clearExclusions

public void clearExclusions()

Clears the set of exclusions.

setUrlClassLoader

public void setUrlClassLoader(java.net.URLClassLoader urlClassLoader)

Sets a classloader to load classes from instead of the system classloader.

Parameters:

urlClassLoader - the classloader to use

getUrlClassLoader

public java.net.URLClassLoader getUrlClassLoader()

Gets the classloader used to load classes.

Returns:

the classloader to use, or null if system classloader

setTypeRepository

public void setTypeRepository(TypeRepository typeRepository)

Sets the type repository used to analyse java classes.

Parameters:

typeRepository - the type repository to use when analysing

getTypeRepository

public TypeRepository getTypeRepository()

Gets the type repository used to analyse java classes.

Returns:

the type supplied type repository, or a default implementation