Package org.springframework.modulith.core

Class FormattableType

java.lang.Object

org.springframework.modulith.core.FormattableType

public class FormattableType
extends Object

Wrapper around JavaClass that allows creating additional formatted names.

Author:

Oliver Drotbohm

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	FormattableType.NonModuleTypeAbbreviation	How to handle types that are not contained in an ApplicationModule.

Method Summary

Modifier and Type	Method	Description
static String	format(Iterable<com.tngtech.archunit.core.domain.JavaClass> types)	Formats the given JavaClasses by rendering a comma-separated list with the abbreviated class names.
String	getAbbreviatedFullName()	Returns the abbreviated (i.e. every package fragment reduced to its first character) full name, e.g.
String	getAbbreviatedFullName(@Nullable ApplicationModule module)	Returns the abbreviated full name of the type abbreviating only the part of the given ApplicationModule's base package.
String	getAbbreviatedFullName(@Nullable ApplicationModule module, FormattableType.NonModuleTypeAbbreviation abbreviation)	Returns the abbreviated full name of the type abbreviating only the part of the given ApplicationModule's base package.
String	getFullName()	Returns the type's full name.
static FormattableType	of(com.tngtech.archunit.core.domain.JavaClass type)	Creates a new FormattableType for the given JavaClass.
static FormattableType	of(Class<?> type)	Creates a new FormattableType for the given Class.

Methods inherited from class java.lang.Object

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

Method Details

of

public static FormattableType of(com.tngtech.archunit.core.domain.JavaClass type)

Creates a new FormattableType for the given JavaClass.

Parameters:

type - must not be null.

Returns:

will never be null.

of

public static FormattableType of(Class<?> type)

Creates a new FormattableType for the given Class.

Parameters:

type - must not be null.

Returns:

will never be null.

format

public static String format(Iterable<com.tngtech.archunit.core.domain.JavaClass> types)

Formats the given JavaClasses by rendering a comma-separated list with the abbreviated class names.

Parameters:

types - must not be null.

Returns:

will never be null.

getAbbreviatedFullName

public String getAbbreviatedFullName()

Returns the abbreviated (i.e. every package fragment reduced to its first character) full name, e.g. com.acme.MyType will result in c.a.MyType.

Returns:

will never be null.

getAbbreviatedFullName

public String getAbbreviatedFullName(@Nullable ApplicationModule module)

Returns the abbreviated full name of the type abbreviating only the part of the given ApplicationModule's base package.

Parameters:

module - can be null.

Returns:

will never be null.

getAbbreviatedFullName

public String getAbbreviatedFullName(@Nullable ApplicationModule module,
 FormattableType.NonModuleTypeAbbreviation abbreviation)

Returns the abbreviated full name of the type abbreviating only the part of the given ApplicationModule's base package.

Parameters:

module - can be null.

abbreviation - must not be null.

Returns:

will never be null.

Since:

2.1

getFullName

public String getFullName()

Returns the type's full name.

Returns:

will never be null.