com.structurizr.analysis

Class TypeUtils

java.lang.Object

com.structurizr.analysis.TypeUtils

public class TypeUtils
extends java.lang.Object

Some utility methods for working with types.

Constructor Summary

Constructors

Constructor and Description
TypeUtils()

Method Summary

Modifier and Type	Method and Description
static java.lang.Class	findFirstImplementationOfInterface(java.lang.Class interfaceType, java.util.Set<java.lang.Class<?>> types) Finds the first implementation of the given interface.
static java.util.Set<java.lang.Class<?>>	findTypesAnnotatedWith(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.util.Set<java.lang.Class<?>> types) Finds the set of types that are annotated with the specified annotation.
static TypeCategory	getCategory(TypeRepository typeRepository, java.lang.String typeName) Finds the category of a given type.
static TypeVisibility	getVisibility(TypeRepository typeRepository, java.lang.String typeName) Finds the visibility of a given type.

Methods inherited from class java.lang.Object

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

Constructor Detail

TypeUtils

public TypeUtils()

Method Detail

getVisibility

public static TypeVisibility getVisibility(TypeRepository typeRepository,
                                           java.lang.String typeName)

Finds the visibility of a given type.

Parameters:

typeRepository - the repository where types should be loaded from

typeName - the fully qualified type name

Returns:

a TypeVisibility object representing the visibility (e.g. public, package, etc)

getCategory

public static TypeCategory getCategory(TypeRepository typeRepository,
                                       java.lang.String typeName)

Finds the category of a given type.

Parameters:

typeRepository - the repository where types should be loaded from

typeName - the fully qualified type name

Returns:

a TypeCategory object representing the category (e.g. class, interface, enum, etc)

findTypesAnnotatedWith

public static java.util.Set<java.lang.Class<?>> findTypesAnnotatedWith(java.lang.Class<? extends java.lang.annotation.Annotation> annotation,
                                                                       java.util.Set<java.lang.Class<?>> types)

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

Parameters:

annotation - the Annotation to find

types - the set of Class objects to search through

Returns:

a Set of Class objects, or an empty set of none could be found

findFirstImplementationOfInterface

public static java.lang.Class findFirstImplementationOfInterface(java.lang.Class interfaceType,
                                                                 java.util.Set<java.lang.Class<?>> types)

Finds the first implementation of the given interface.

Parameters:

interfaceType - a Class object representing the interface type

types - the set of Class objects to search through

Returns:

the first concrete implementation class of the given interface, or null if one can't be found