A B C D E F G I L M N P R S T

A

ABSTRACT_CLASS - Static variable in class com.structurizr.analysis.TypeCategory

AbstractComponentFinderStrategy - Class in com.structurizr.analysis

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

AbstractComponentFinderStrategy(SupportingTypesStrategy...) - Constructor for class com.structurizr.analysis.AbstractComponentFinderStrategy

AbstractTypeMatcher - Class in com.structurizr.analysis

A superclass used for TypeMatcher implementations.

AbstractTypeMatcher(String, String) - Constructor for class com.structurizr.analysis.AbstractTypeMatcher

addComponent(Container, String, String, String, String) - Method in class com.structurizr.analysis.AbstractComponentFinderStrategy

addPackageName(String) - Method in class com.structurizr.analysis.ComponentFinder

Adds a package name to be scanned.

addSupportingTypesStrategy(SupportingTypesStrategy) - Method in class com.structurizr.analysis.AbstractComponentFinderStrategy

Adds a supporting type strategy to this component finder strategy.

afterFindComponents() - Method in class com.structurizr.analysis.AbstractComponentFinderStrategy

afterFindComponents() - Method in interface com.structurizr.analysis.ComponentFinderStrategy

Called after all component finder strategies belonging to the same component finder have found components.

afterFindComponents() - Method in class com.structurizr.analysis.SourceCodeComponentFinderStrategy

afterFindComponents() - Method in class com.structurizr.analysis.StructurizrAnnotationsComponentFinderStrategy

AnnotatedMethodComponentFinderStrategy - Class in com.structurizr.analysis

A generic component finder strategy that finds components based on returned types of specifically annotated methods.

AnnotatedMethodComponentFinderStrategy(Class<? extends Annotation>) - Constructor for class com.structurizr.analysis.AnnotatedMethodComponentFinderStrategy

Construct strategy that finds components based on return type of methods annotated with methodAnnotation

AnnotatedMethodComponentFinderStrategy(Class<? extends Annotation>, DuplicateComponentStrategy) - Constructor for class com.structurizr.analysis.AnnotatedMethodComponentFinderStrategy

AnnotatedMethodComponentFinderStrategy(Class<? extends Annotation>, Class<? extends Annotation>) - Constructor for class com.structurizr.analysis.AnnotatedMethodComponentFinderStrategy

Construct strategy that finds components based on return type of methods annotated with methodAnnotation which belong only to classes annotated with classAnnotation

AnnotatedMethodComponentFinderStrategy(Class<? extends Annotation>, Class<? extends Annotation>, DuplicateComponentStrategy, SupportingTypesStrategy...) - Constructor for class com.structurizr.analysis.AnnotatedMethodComponentFinderStrategy

Construct strategy that finds components based on return type of methods annotated with methodAnnotation which belong only to classes annotated with classAnnotation.

AnnotationTypeMatcher - Class in com.structurizr.analysis

Matches types based upon the presence of a type-level annotation.

AnnotationTypeMatcher(Class<? extends Annotation>, String, String) - Constructor for class com.structurizr.analysis.AnnotationTypeMatcher

B

beforeFindComponents() - Method in class com.structurizr.analysis.AbstractComponentFinderStrategy

beforeFindComponents() - Method in interface com.structurizr.analysis.ComponentFinderStrategy

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

beforeFindComponents() - Method in class com.structurizr.analysis.SourceCodeComponentFinderStrategy

C

CLASS - Static variable in class com.structurizr.analysis.TypeCategory

clearExclusions() - Method in class com.structurizr.analysis.ComponentFinder

Clears the set of exclusions.

com.structurizr.analysis - package com.structurizr.analysis

componentFinder - Variable in class com.structurizr.analysis.AbstractComponentFinderStrategy

ComponentFinder - Class in com.structurizr.analysis

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

ComponentFinder(Container, String, ComponentFinderStrategy...) - Constructor for class com.structurizr.analysis.ComponentFinder

Create a new component finder.

ComponentFinderStrategy - Interface in com.structurizr.analysis

The interface that all component finder strategies must implement.

componentsFound - Variable in class com.structurizr.analysis.AbstractComponentFinderStrategy

D

DefaultTypeRepository - Class in com.structurizr.analysis

This is an implementation of a TypeRepository that uses a combination of: - The Reflections library (https://github.com/ronmamo/reflections).

doFindComponents() - Method in class com.structurizr.analysis.AbstractComponentFinderStrategy

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

doFindComponents() - Method in class com.structurizr.analysis.AnnotatedMethodComponentFinderStrategy

doFindComponents() - Method in class com.structurizr.analysis.StructurizrAnnotationsComponentFinderStrategy

doFindComponents() - Method in class com.structurizr.analysis.TypeMatcherComponentFinderStrategy

DuplicateComponentException - Exception in com.structurizr.analysis

duplicateComponentFound(Component, String, String, String, String) - Method in interface com.structurizr.analysis.DuplicateComponentStrategy

Called when a duplicate component is found.

duplicateComponentFound(Component, String, String, String, String) - Method in class com.structurizr.analysis.IgnoreDuplicateComponentStrategy

duplicateComponentFound(Component, String, String, String, String) - Method in class com.structurizr.analysis.ThrowExceptionDuplicateComponentStrategy

DuplicateComponentStrategy - Interface in com.structurizr.analysis

Defines a strategy that should be called when a duplicate component is found.

E

ENUM - Static variable in class com.structurizr.analysis.TypeCategory

exclude(String...) - Method in class com.structurizr.analysis.ComponentFinder

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

ExtendsClassTypeMatcher - Class in com.structurizr.analysis

Matches types where the type extends the specified class.

ExtendsClassTypeMatcher(Class, String, String) - Constructor for class com.structurizr.analysis.ExtendsClassTypeMatcher

F

findClassesWithAnnotation(Class<? extends Annotation>, String) - Method in class com.structurizr.analysis.AbstractComponentFinderStrategy

findClassesWithAnnotation(Class<? extends Annotation>, String, boolean) - Method in class com.structurizr.analysis.AbstractComponentFinderStrategy

findComponents() - Method in class com.structurizr.analysis.AbstractComponentFinderStrategy

findComponents() - Method in class com.structurizr.analysis.ComponentFinder

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

findComponents() - Method in interface com.structurizr.analysis.ComponentFinderStrategy

Finds components.

findComponents() - Method in class com.structurizr.analysis.SourceCodeComponentFinderStrategy

findDependencies() - Method in class com.structurizr.analysis.AbstractComponentFinderStrategy

findFirstImplementationOfInterface(Class, Set<Class<?>>) - Static method in class com.structurizr.analysis.TypeUtils

Finds the first implementation of the given interface.

findReferencedTypes(String) - Method in class com.structurizr.analysis.DefaultTypeRepository

Finds the set of types referenced by the specified type.

findReferencedTypes(String) - Method in interface com.structurizr.analysis.TypeRepository

Finds the set of types referenced by the specified type.

findSupportingTypes(Set<Component>) - Method in class com.structurizr.analysis.AbstractComponentFinderStrategy

findSupportingTypes(Component) - Method in class com.structurizr.analysis.FirstImplementationOfInterfaceSupportingTypesStrategy

findSupportingTypes(Component) - Method in class com.structurizr.analysis.ReferencedTypesInSamePackageSupportingTypesStrategy

findSupportingTypes(Component) - Method in class com.structurizr.analysis.ReferencedTypesSupportingTypesStrategy

findSupportingTypes(Component) - Method in class com.structurizr.analysis.SupportingTypesStrategy

findTypesAnnotatedWith(Class<? extends Annotation>) - Method in class com.structurizr.analysis.AbstractComponentFinderStrategy

findTypesAnnotatedWith(Class<? extends Annotation>, Set<Class<?>>) - Static method in class com.structurizr.analysis.TypeUtils

Finds the set of types that are annotated with the specified annotation.

FirstImplementationOfInterfaceSupportingTypesStrategy - Class in com.structurizr.analysis

If the component type is an interface, this strategy finds the first implementation of that interface.

FirstImplementationOfInterfaceSupportingTypesStrategy() - Constructor for class com.structurizr.analysis.FirstImplementationOfInterfaceSupportingTypesStrategy

G

getAllTypes() - Method in class com.structurizr.analysis.DefaultTypeRepository

Gets all of the types found by this type repository.

getAllTypes() - Method in interface com.structurizr.analysis.TypeRepository

Gets all of the types found by this type repository.

getCategory(TypeRepository, String) - Static method in class com.structurizr.analysis.TypeUtils

Finds the category of a given type.

getComponentFinder() - Method in class com.structurizr.analysis.AbstractComponentFinderStrategy

getContainer() - Method in class com.structurizr.analysis.ComponentFinder

Gets the Container that components will be added to.

getDescription() - Method in class com.structurizr.analysis.AbstractTypeMatcher

getDescription() - Method in interface com.structurizr.analysis.TypeMatcher

getDuplicateComponentStrategy() - Method in class com.structurizr.analysis.AbstractComponentFinderStrategy

getExclusions() - Method in class com.structurizr.analysis.ComponentFinder

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

getName() - Method in class com.structurizr.analysis.TypeCategory

getName() - Method in class com.structurizr.analysis.TypeVisibility

getPackageNames() - Method in class com.structurizr.analysis.ComponentFinder

Gets the names of the packages to be scanned.

getPackages() - Method in class com.structurizr.analysis.DefaultTypeRepository

Gets the packages that this type repository is associated with scanning.

getPackages() - Method in interface com.structurizr.analysis.TypeRepository

Gets the packages that this type repository is associated with scanning.

getTechnology() - Method in class com.structurizr.analysis.AbstractTypeMatcher

getTechnology() - Method in interface com.structurizr.analysis.TypeMatcher

getTypeRepository() - Method in class com.structurizr.analysis.AbstractComponentFinderStrategy

getTypeRepository() - Method in class com.structurizr.analysis.ComponentFinder

Gets the type repository used to analyse java classes.

getTypeRepository() - Method in class com.structurizr.analysis.SupportingTypesStrategy

getUrlClassLoader() - Method in class com.structurizr.analysis.ComponentFinder

Gets the classloader used to load classes.

getVisibility(TypeRepository, String) - Static method in class com.structurizr.analysis.TypeUtils

Finds the visibility of a given type.

I

IgnoreDuplicateComponentStrategy - Class in com.structurizr.analysis

IgnoreDuplicateComponentStrategy() - Constructor for class com.structurizr.analysis.IgnoreDuplicateComponentStrategy

ImplementsInterfaceTypeMatcher - Class in com.structurizr.analysis

Matches types where the type implements the specified interface.

ImplementsInterfaceTypeMatcher(Class, String, String) - Constructor for class com.structurizr.analysis.ImplementsInterfaceTypeMatcher

INTERFACE - Static variable in class com.structurizr.analysis.TypeCategory

L

loadClass(String) - Method in class com.structurizr.analysis.DefaultTypeRepository

loadClass(String) - Method in interface com.structurizr.analysis.TypeRepository

Loads the specified type.

M

matches(Class) - Method in class com.structurizr.analysis.AnnotationTypeMatcher

matches(Class) - Method in class com.structurizr.analysis.ExtendsClassTypeMatcher

matches(Class) - Method in class com.structurizr.analysis.ImplementsInterfaceTypeMatcher

matches(Class) - Method in class com.structurizr.analysis.NameSuffixTypeMatcher

matches(Class) - Method in class com.structurizr.analysis.RegexTypeMatcher

matches(Class) - Method in interface com.structurizr.analysis.TypeMatcher

N

NameSuffixTypeMatcher - Class in com.structurizr.analysis

Matches types where the name of the type ends with the specified suffix.

NameSuffixTypeMatcher(String, String, String) - Constructor for class com.structurizr.analysis.NameSuffixTypeMatcher

P

PACKAGE - Static variable in class com.structurizr.analysis.TypeVisibility

PRIVATE - Static variable in class com.structurizr.analysis.TypeVisibility

PROTECTED - Static variable in class com.structurizr.analysis.TypeVisibility

PUBLIC - Static variable in class com.structurizr.analysis.TypeVisibility

R

ReferencedTypesInSamePackageSupportingTypesStrategy - Class in com.structurizr.analysis

This strategy finds all referenced types in the same package as the component type, and is useful if each component resides in its own Java package.

ReferencedTypesInSamePackageSupportingTypesStrategy() - Constructor for class com.structurizr.analysis.ReferencedTypesInSamePackageSupportingTypesStrategy

ReferencedTypesInSamePackageSupportingTypesStrategy(boolean) - Constructor for class com.structurizr.analysis.ReferencedTypesInSamePackageSupportingTypesStrategy

ReferencedTypesSupportingTypesStrategy - Class in com.structurizr.analysis

This strategy finds all types that are referenced by the component type and supporting types.

ReferencedTypesSupportingTypesStrategy() - Constructor for class com.structurizr.analysis.ReferencedTypesSupportingTypesStrategy

ReferencedTypesSupportingTypesStrategy(boolean) - Constructor for class com.structurizr.analysis.ReferencedTypesSupportingTypesStrategy

RegexTypeMatcher - Class in com.structurizr.analysis

Matches types using a regex against the fully qualified type name.

RegexTypeMatcher(String, String, String) - Constructor for class com.structurizr.analysis.RegexTypeMatcher

RegexTypeMatcher(Pattern, String, String) - Constructor for class com.structurizr.analysis.RegexTypeMatcher

S

setComponentFinder(ComponentFinder) - Method in class com.structurizr.analysis.AbstractComponentFinderStrategy

Sets a reference to the parent component finder.

setComponentFinder(ComponentFinder) - Method in interface com.structurizr.analysis.ComponentFinderStrategy

Sets a reference to the parent component finder.

setComponentFinder(ComponentFinder) - Method in class com.structurizr.analysis.SourceCodeComponentFinderStrategy

setDuplicateComponentStrategy(DuplicateComponentStrategy) - Method in class com.structurizr.analysis.AbstractComponentFinderStrategy

setEncoding(String) - Method in class com.structurizr.analysis.SourceCodeComponentFinderStrategy

setTypeRepository(TypeRepository) - Method in class com.structurizr.analysis.ComponentFinder

Sets the type repository used to analyse java classes.

setUrlClassLoader(URLClassLoader) - Method in class com.structurizr.analysis.ComponentFinder

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

SourceCodeComponentFinderStrategy - Class in com.structurizr.analysis

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.

SourceCodeComponentFinderStrategy(File) - Constructor for class com.structurizr.analysis.SourceCodeComponentFinderStrategy

SourceCodeComponentFinderStrategy(File, int) - Constructor for class com.structurizr.analysis.SourceCodeComponentFinderStrategy

start(RootDoc) - Static method in class com.structurizr.analysis.SourceCodeComponentFinderStrategy

StructurizrAnnotationsComponentFinderStrategy - Class in com.structurizr.analysis

This component finder strategy looks for the following Structurizr annotations.

StructurizrAnnotationsComponentFinderStrategy() - Constructor for class com.structurizr.analysis.StructurizrAnnotationsComponentFinderStrategy

StructurizrAnnotationsComponentFinderStrategy(SupportingTypesStrategy...) - Constructor for class com.structurizr.analysis.StructurizrAnnotationsComponentFinderStrategy

supportingTypesStrategies - Variable in class com.structurizr.analysis.AbstractComponentFinderStrategy

SupportingTypesStrategy - Class in com.structurizr.analysis

Superclass for strategies used to find the types that support a component.

SupportingTypesStrategy() - Constructor for class com.structurizr.analysis.SupportingTypesStrategy

T

ThrowExceptionDuplicateComponentStrategy - Class in com.structurizr.analysis

Throws an exception when a duplicate component is found.

ThrowExceptionDuplicateComponentStrategy() - Constructor for class com.structurizr.analysis.ThrowExceptionDuplicateComponentStrategy

toString() - Method in class com.structurizr.analysis.TypeCategory

toString() - Method in class com.structurizr.analysis.TypeVisibility

TypeCategory - Class in com.structurizr.analysis

TypeMatcher - Interface in com.structurizr.analysis

Determines whether a given type implements the rules for being identified as a component.

TypeMatcherComponentFinderStrategy - Class in com.structurizr.analysis

A component finder strategy that uses type information to find components, based upon a number of pluggable TypeMatcher implementations.

TypeMatcherComponentFinderStrategy(TypeMatcher...) - Constructor for class com.structurizr.analysis.TypeMatcherComponentFinderStrategy

TypeRepository - Interface in com.structurizr.analysis

This represents an abstraction for a repository of type information.

TypeUtils - Class in com.structurizr.analysis

Some utility methods for working with types.

TypeUtils() - Constructor for class com.structurizr.analysis.TypeUtils

TypeVisibility - Class in com.structurizr.analysis

A B C D E F G I L M N P R S T