Package com.tngtech.archunit.core.domain
Class Formatters
- java.lang.Object
-
- com.tngtech.archunit.core.domain.Formatters
-
public final class Formatters extends java.lang.Object
-
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static java.lang.String
ensureSimpleName(java.lang.String name)
static java.lang.String
formatMethod(java.lang.String ownerName, java.lang.String methodName, JavaClassList parameters)
static java.lang.String
formatMethod(java.lang.String ownerName, java.lang.String methodName, java.util.List<java.lang.String> parameters)
static java.lang.String
formatMethodParameterTypeNames(java.util.List<java.lang.String> typeNames)
static java.lang.String
formatMethodSimple(java.lang.String ownerName, java.lang.String methodName, java.util.List<java.lang.String> parameters)
static java.lang.String
formatThrowsDeclarationTypeNames(java.util.List<java.lang.String> typeNames)
-
-
-
Method Detail
-
formatMethod
@PublicAPI(usage=ACCESS) public static java.lang.String formatMethod(java.lang.String ownerName, java.lang.String methodName, JavaClassList parameters)
- Parameters:
ownerName
- Class name where the method is declaredmethodName
- Name of the methodparameters
- Parameters of the method- Returns:
- Arguments formatted as "ownerName.methodName(fqn.param1, fqn.param2, ...)"
-
formatMethodSimple
@PublicAPI(usage=ACCESS) public static java.lang.String formatMethodSimple(java.lang.String ownerName, java.lang.String methodName, java.util.List<java.lang.String> parameters)
- Parameters:
ownerName
- Class name where the method is declared (may be simple or fqn)methodName
- Name of the methodparameters
- Names of parameter types (may be simple or fqn)- Returns:
- Arguments formatted as "simple(ownerName).methodName(simple(param1), simple(param2), ...)",
where simple(..) ensures the simple type name (compare
ensureSimpleName(String)
)
-
formatMethod
@PublicAPI(usage=ACCESS) public static java.lang.String formatMethod(java.lang.String ownerName, java.lang.String methodName, java.util.List<java.lang.String> parameters)
- Parameters:
ownerName
- Class name where the method is declaredmethodName
- Name of the methodparameters
- Names of parameter types- Returns:
- Arguments formatted (as passed) as "ownerName.methodName(param1, param2, ...)"
-
formatMethodParameterTypeNames
@PublicAPI(usage=ACCESS) public static java.lang.String formatMethodParameterTypeNames(java.util.List<java.lang.String> typeNames)
- Parameters:
typeNames
- List of method parameter type names- Returns:
- Arguments formatted as "param1, param2, ..."
-
formatThrowsDeclarationTypeNames
@PublicAPI(usage=ACCESS) public static java.lang.String formatThrowsDeclarationTypeNames(java.util.List<java.lang.String> typeNames)
- Parameters:
typeNames
- List of throws declaration type names- Returns:
- Arguments formatted as "param1, param2, ..."
-
ensureSimpleName
@PublicAPI(usage=ACCESS) public static java.lang.String ensureSimpleName(java.lang.String name)
- Parameters:
name
- A possibly fully qualified class name- Returns:
- A best guess of the simple name, i.e. prefixes like 'a.b.c.' cut off, 'Some$' of 'Some$Inner' as well. Returns an empty String, if the name belongs to an anonymous class (e.g. some.Type$1).
-
-