Module org.jmolecules.integrations.archunit

Package org.jmolecules.archunit

Class JMoleculesArchitectureRules.StereotypeLookup

java.lang.Object

org.jmolecules.archunit.JMoleculesArchitectureRules.StereotypeLookup

Enclosing class:

JMoleculesArchitectureRules

public static class JMoleculesArchitectureRules.StereotypeLookup
extends Object

A strategy how to look up stereotypes for the classes to be analyzed. Can either be on the types themselves including a package-level assignment (via defaultLookup()) or via a marker type that acts as replacement for the package-level lookup.

Since:

0.22

Author:

Oliver Drotbohm

Method Summary

Modifier and Type	Method	Description
static JMoleculesArchitectureRules.StereotypeLookup	defaultLookup()	Creates a default JMoleculesArchitectureRules.StereotypeLookup, which means it for each type, it will try to find the annotation on the type itself or any meta annotations and falls back to traversing the package annotations.
static JMoleculesArchitectureRules.StereotypeLookup	onMarkerType(String name)	Creates a JMoleculesArchitectureRules.StereotypeLookup trying to find the stereotype annotation on a marker type located in the reference type's package or parent package.
static JMoleculesArchitectureRules.StereotypeLookup	onMarkerTypeName(Class<?> type)	Creates a JMoleculesArchitectureRules.StereotypeLookup trying to find the stereotype annotation on marker types with the same simple name as the given one located in the reference type's package or parent package.
JMoleculesArchitectureRules.StereotypeLookup	withParentPackageTraversal()	Configures the JMoleculesArchitectureRules.StereotypeLookup to also look for package-based stereotypes in parent packages.

Methods inherited from class java.lang.Object

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

Method Details

defaultLookup

public static JMoleculesArchitectureRules.StereotypeLookup defaultLookup()

Creates a default JMoleculesArchitectureRules.StereotypeLookup, which means it for each type, it will try to find the annotation on the type itself or any meta annotations and falls back to traversing the package annotations.

Returns:

will never be null.

onMarkerType

public static JMoleculesArchitectureRules.StereotypeLookup onMarkerType(String name)

Creates a JMoleculesArchitectureRules.StereotypeLookup trying to find the stereotype annotation on a marker type located in the reference type's package or parent package.

Parameters:

name - will never be null or empty.

Returns:

will never be null.

onMarkerTypeName

public static JMoleculesArchitectureRules.StereotypeLookup onMarkerTypeName(Class<?> type)

Creates a JMoleculesArchitectureRules.StereotypeLookup trying to find the stereotype annotation on marker types with the same simple name as the given one located in the reference type's package or parent package.

Parameters:

type - will never be null or empty.

Returns:

will never be null.

withParentPackageTraversal

public JMoleculesArchitectureRules.StereotypeLookup withParentPackageTraversal()

Configures the JMoleculesArchitectureRules.StereotypeLookup to also look for package-based stereotypes in parent packages. Defaults to false to be able to freely reassign stereotypes to types in nested packages.

Returns:

will never be null.

Since:

0.30