com.structurizr.analysis

Class AnnotatedMethodComponentFinderStrategy

java.lang.Object

com.structurizr.analysis.AbstractComponentFinderStrategy

com.structurizr.analysis.AnnotatedMethodComponentFinderStrategy

All Implemented Interfaces:

ComponentFinderStrategy

public class AnnotatedMethodComponentFinderStrategy
extends AbstractComponentFinderStrategy

A generic component finder strategy that finds components based on returned types of specifically annotated methods. To filter scanned classes for specifically annotated methods specify classAnnotation as well. This strategy uses first found implementation as a type property for a Component and when component duplicates are found it behaves according to passed DuplicateComponentStrategy (by default it ignores duplicates if nothing is passed to constructor).

 With example below this strategy finds 2 components based on method annotation  @Bean,
 e.g. component with name "SomeComponent" has efferent relation to "SomeEfferentComponent".

  @Configuration
  public class SomeConfiguration {

     @Bean
     public SomeComponent someComponent(SomeEfferentComponent someEfferentComponent) {
         return new SomeComponentImpl(someEfferentComponent);
     }

     @Bean
     public SomeEfferentComponent someEfferentComponent() {
         return new SomeEfferentComponentImpl();
     }
  }
 

Field Summary

Fields inherited from class com.structurizr.analysis.AbstractComponentFinderStrategy

componentFinder, componentsFound, supportingTypesStrategies

Constructor Summary

Constructors

Constructor and Description
AnnotatedMethodComponentFinderStrategy(java.lang.Class<? extends java.lang.annotation.Annotation> methodAnnotation) Construct strategy that finds components based on return type of methods annotated with methodAnnotation
AnnotatedMethodComponentFinderStrategy(java.lang.Class<? extends java.lang.annotation.Annotation> methodAnnotation, java.lang.Class<? extends java.lang.annotation.Annotation> classAnnotation) Construct strategy that finds components based on return type of methods annotated with methodAnnotation which belong only to classes annotated with classAnnotation
AnnotatedMethodComponentFinderStrategy(java.lang.Class<? extends java.lang.annotation.Annotation> methodAnnotation, java.lang.Class<? extends java.lang.annotation.Annotation> classAnnotation, DuplicateComponentStrategy duplicateComponentStrategy, SupportingTypesStrategy... strategies) Construct strategy that finds components based on return type of methods annotated with methodAnnotation which belong only to classes annotated with classAnnotation.
AnnotatedMethodComponentFinderStrategy(java.lang.Class<? extends java.lang.annotation.Annotation> methodAnnotation, DuplicateComponentStrategy duplicateComponentStrategy)

Method Summary

Modifier and Type	Method and Description
protected java.util.Set<com.structurizr.model.Component>	doFindComponents() A template method into which subclasses can put their component finding code.

Methods inherited from class com.structurizr.analysis.AbstractComponentFinderStrategy

addComponent, addSupportingTypesStrategy, afterFindComponents, beforeFindComponents, findClassesWithAnnotation, findClassesWithAnnotation, findComponents, findDependencies, findSupportingTypes, findTypesAnnotatedWith, getComponentFinder, getDuplicateComponentStrategy, getTypeRepository, setComponentFinder, setDuplicateComponentStrategy

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotatedMethodComponentFinderStrategy

public AnnotatedMethodComponentFinderStrategy(java.lang.Class<? extends java.lang.annotation.Annotation> methodAnnotation)

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

Parameters:

methodAnnotation - the annotation to look for on methods

AnnotatedMethodComponentFinderStrategy

public AnnotatedMethodComponentFinderStrategy(java.lang.Class<? extends java.lang.annotation.Annotation> methodAnnotation,
                                              DuplicateComponentStrategy duplicateComponentStrategy)

AnnotatedMethodComponentFinderStrategy

public AnnotatedMethodComponentFinderStrategy(java.lang.Class<? extends java.lang.annotation.Annotation> methodAnnotation,
                                              java.lang.Class<? extends java.lang.annotation.Annotation> classAnnotation)

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

Parameters:

methodAnnotation - the annotation to look for on methods

classAnnotation - the annotation to look for on classes/interfaces

AnnotatedMethodComponentFinderStrategy

public AnnotatedMethodComponentFinderStrategy(@Nonnull
                                              java.lang.Class<? extends java.lang.annotation.Annotation> methodAnnotation,
                                              @Nullable
                                              java.lang.Class<? extends java.lang.annotation.Annotation> classAnnotation,
                                              @Nullable
                                              DuplicateComponentStrategy duplicateComponentStrategy,
                                              SupportingTypesStrategy... strategies)

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

Parameters:

methodAnnotation - the annotation to look for on methods

classAnnotation - the annotation to look for on classes/interfaces to narrow scanned scope of methods

duplicateComponentStrategy - strategy how to behave when component duplicates found

strategies - strategies to look for supporting types for a component (component hides all types which support defined in component functionality behind abstraction)

Method Detail

doFindComponents

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

Description copied from class: AbstractComponentFinderStrategy

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

Specified by:

doFindComponents in class AbstractComponentFinderStrategy

Returns:

the Set of Components found, or an empty set if no components were found