Class DisplayNameUtils


  • final class DisplayNameUtils
    extends java.lang.Object
    Collection of utilities for working with display names.
    Since:
    5.4
    See Also:
    DisplayName, DisplayNameGenerator, DisplayNameGeneration
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private static org.junit.jupiter.api.DisplayNameGenerator indicativeSentencesGenerator
      Pre-defined display name generator instance producing indicative sentences.
      private static org.junit.jupiter.api.DisplayNameGenerator replaceUnderscoresGenerator
      Pre-defined display name generator instance replacing underscores.
      private static org.junit.jupiter.api.DisplayNameGenerator simpleGenerator
      Pre-defined simple display name generator instance.
      private static org.junit.jupiter.api.DisplayNameGenerator standardGenerator
      Pre-defined standard display name generator instance.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      private static java.util.function.Supplier<java.lang.String> createDisplayNameSupplier​(java.util.function.Supplier<java.util.List<java.lang.Class<?>>> enclosingInstanceTypesSupplier, java.lang.Class<?> testClass, JupiterConfiguration configuration, java.util.function.BiFunction<org.junit.jupiter.api.DisplayNameGenerator,​java.util.List<java.lang.Class<?>>,​java.lang.String> generatorFunction)  
      (package private) static java.util.function.Supplier<java.lang.String> createDisplayNameSupplierForClass​(java.lang.Class<?> testClass, JupiterConfiguration configuration)  
      private static java.util.function.Supplier<java.lang.String> createDisplayNameSupplierForMethod​(java.util.function.Supplier<java.util.List<java.lang.Class<?>>> enclosingInstanceTypesSupplier, java.lang.Class<?> testClass, java.lang.reflect.Method testMethod, JupiterConfiguration configuration)  
      (package private) static java.util.function.Supplier<java.lang.String> createDisplayNameSupplierForNestedClass​(java.util.function.Supplier<java.util.List<java.lang.Class<?>>> enclosingInstanceTypesSupplier, java.lang.Class<?> testClass, JupiterConfiguration configuration)  
      (package private) static java.lang.String determineDisplayName​(java.lang.reflect.AnnotatedElement element, java.util.function.Supplier<java.lang.String> displayNameSupplier)  
      (package private) static java.lang.String determineDisplayNameForMethod​(java.util.function.Supplier<java.util.List<java.lang.Class<?>>> enclosingInstanceTypes, java.lang.Class<?> testClass, java.lang.reflect.Method testMethod, JupiterConfiguration configuration)  
      private static java.util.Optional<org.junit.jupiter.api.DisplayNameGenerator> findDisplayNameGenerator​(java.util.List<java.lang.Class<?>> enclosingInstanceTypes, java.lang.Class<?> testClass)  
      private static <T> java.util.List<T> makeUnmodifiable​(java.util.List<T> list)  
      (package private) static void validateAnnotation​(java.lang.reflect.AnnotatedElement element, java.util.function.Supplier<java.lang.String> elementDescription, java.util.function.Supplier<TestSource> sourceProvider, DiscoveryIssueReporter reporter)  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • standardGenerator

        private static final org.junit.jupiter.api.DisplayNameGenerator standardGenerator
        Pre-defined standard display name generator instance.
      • simpleGenerator

        private static final org.junit.jupiter.api.DisplayNameGenerator simpleGenerator
        Pre-defined simple display name generator instance.
      • replaceUnderscoresGenerator

        private static final org.junit.jupiter.api.DisplayNameGenerator replaceUnderscoresGenerator
        Pre-defined display name generator instance replacing underscores.
      • indicativeSentencesGenerator

        private static final org.junit.jupiter.api.DisplayNameGenerator indicativeSentencesGenerator
        Pre-defined display name generator instance producing indicative sentences.
    • Constructor Detail

      • DisplayNameUtils

        DisplayNameUtils()
    • Method Detail

      • determineDisplayName

        static java.lang.String determineDisplayName​(java.lang.reflect.AnnotatedElement element,
                                                     java.util.function.Supplier<java.lang.String> displayNameSupplier)
      • validateAnnotation

        static void validateAnnotation​(java.lang.reflect.AnnotatedElement element,
                                       java.util.function.Supplier<java.lang.String> elementDescription,
                                       java.util.function.Supplier<TestSource> sourceProvider,
                                       DiscoveryIssueReporter reporter)
      • determineDisplayNameForMethod

        static java.lang.String determineDisplayNameForMethod​(java.util.function.Supplier<java.util.List<java.lang.Class<?>>> enclosingInstanceTypes,
                                                              java.lang.Class<?> testClass,
                                                              java.lang.reflect.Method testMethod,
                                                              JupiterConfiguration configuration)
      • createDisplayNameSupplierForClass

        static java.util.function.Supplier<java.lang.String> createDisplayNameSupplierForClass​(java.lang.Class<?> testClass,
                                                                                               JupiterConfiguration configuration)
      • createDisplayNameSupplierForNestedClass

        static java.util.function.Supplier<java.lang.String> createDisplayNameSupplierForNestedClass​(java.util.function.Supplier<java.util.List<java.lang.Class<?>>> enclosingInstanceTypesSupplier,
                                                                                                     java.lang.Class<?> testClass,
                                                                                                     JupiterConfiguration configuration)
      • createDisplayNameSupplierForMethod

        private static java.util.function.Supplier<java.lang.String> createDisplayNameSupplierForMethod​(java.util.function.Supplier<java.util.List<java.lang.Class<?>>> enclosingInstanceTypesSupplier,
                                                                                                        java.lang.Class<?> testClass,
                                                                                                        java.lang.reflect.Method testMethod,
                                                                                                        JupiterConfiguration configuration)
      • createDisplayNameSupplier

        private static java.util.function.Supplier<java.lang.String> createDisplayNameSupplier​(java.util.function.Supplier<java.util.List<java.lang.Class<?>>> enclosingInstanceTypesSupplier,
                                                                                               java.lang.Class<?> testClass,
                                                                                               JupiterConfiguration configuration,
                                                                                               java.util.function.BiFunction<org.junit.jupiter.api.DisplayNameGenerator,​java.util.List<java.lang.Class<?>>,​java.lang.String> generatorFunction)
      • makeUnmodifiable

        private static <T> java.util.List<T> makeUnmodifiable​(java.util.List<T> list)
      • findDisplayNameGenerator

        private static java.util.Optional<org.junit.jupiter.api.DisplayNameGenerator> findDisplayNameGenerator​(java.util.List<java.lang.Class<?>> enclosingInstanceTypes,
                                                                                                               java.lang.Class<?> testClass)