Class Formatters

java.lang.Object
com.tngtech.archunit.core.domain.Formatters

public final class Formatters
extends java.lang.Object
  • Method Summary

    Modifier and Type Method Description
    static java.lang.String ensureCanonicalArrayTypeName​(java.lang.String typeName)
    Returns the canonical array type name of any array type name passed in.
    static java.lang.String ensureSimpleName​(java.lang.String name)  
    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.util.List<java.lang.String> formatNamesOf​(java.lang.Class<?>... paramTypes)  
    static java.util.List<java.lang.String> formatNamesOf​(java.lang.Iterable<java.lang.Class<?>> paramTypes)  
    static java.lang.String formatThrowsDeclarationTypeNames​(java.util.List<java.lang.String> typeNames)  

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Method Details

    • 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 method
      parameters - 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 declared
      methodName - Name of the method
      parameters - 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, ..."
    • formatNamesOf

      @PublicAPI(usage=ACCESS) public static java.util.List<java.lang.String> formatNamesOf​(java.lang.Class<?>... paramTypes)
      See Also:
      formatNamesOf(Iterable)
    • formatNamesOf

      @PublicAPI(usage=ACCESS) public static java.util.List<java.lang.String> formatNamesOf​(java.lang.Iterable<java.lang.Class<?>> paramTypes)
      Parameters:
      paramTypes - an iterable of Class objects
      Returns:
      A List of fully qualified class names of the passed Class objects
    • 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).
    • ensureCanonicalArrayTypeName

      @PublicAPI(usage=ACCESS) public static java.lang.String ensureCanonicalArrayTypeName​(java.lang.String typeName)
      Returns the canonical array type name of any array type name passed in. Otherwise returns the passed type name as is. For example [Ljava.lang.String; will be reformatted to java.lang.String[] or [I will be reformatted to int[], while java.lang.String would simply be returned as is.
      Parameters:
      typeName - A Java type name
      Returns:
      the passed type name, but for array type names the canonical array type name