Package org.junit.jupiter.engine.extension

Class TestInfoParameterResolver.DefaultTestInfo

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.String displayName  
      private java.util.Set<java.lang.String> tags  
      private java.util.Optional<java.lang.Class<?>> testClass  
      private java.util.Optional<java.lang.reflect.Method> testMethod  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDisplayName()
      Get the display name of the current test or container.
      java.util.Set<java.lang.String> getTags()
      Get the set of all tags for the current test or container.
      java.util.Optional<java.lang.Class<?>> getTestClass()
      Get the Class associated with the current test or container, if available.
      java.util.Optional<java.lang.reflect.Method> getTestMethod()
      Get the Method associated with the current test or container, if available.
      private static java.lang.Object nullSafeGet​(java.util.Optional<?> optional)  
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • displayName

        private final java.lang.String displayName

      • tags

        private final java.util.Set<java.lang.String> tags

      • testClass

        private final java.util.Optional<java.lang.Class<?>> testClass

      • testMethod

        private final java.util.Optional<java.lang.reflect.Method> testMethod

    • Constructor Detail

    • Method Detail

      • getDisplayName

        public java.lang.String getDisplayName()
        Description copied from interface: TestInfo
        Get the display name of the current test or container.

        The display name is either a default name or a custom name configured via @DisplayName.

        Default Display Names

        If the context in which TestInfo is used is at the container level, the default display name is generated based on the name of the test class. For top-level and @Nested test classes, the default display name is the simple name of the class. For static nested test classes, the default display name is the default display name for the enclosing class concatenated with the simple name of the static nested class, separated by a dollar sign ($). For example, the default display names for the following test classes are TopLevelTests, NestedTests, and TopLevelTests$StaticTests. 

           class TopLevelTests {

      @Nested
      class NestedTests {}

      static class StaticTests {}
   }

        If the context in which TestInfo is used is at the test level, the default display name is the name of the test method concatenated with a comma-separated list of simple names of the parameter types in parentheses. For example, the default display name for the following test method is testUser(TestInfo, User). 

           @Test
   void testUser(TestInfo testInfo, @Mock User user) {}

        Note that display names are typically used for test reporting in IDEs and build tools and may contain spaces, special characters, and even emoji.

        Specified by:
        getDisplayName in interface TestInfo
        Returns:
        the display name of the test or container; never null or blank

      • getTags

        public java.util.Set<java.lang.String> getTags()
        Description copied from interface: TestInfo
        Get the set of all tags for the current test or container.

        Tags may be declared directly on the test element or inherited from an outer context.

        Specified by:
        getTags in interface TestInfo

      • getTestClass

        public java.util.Optional<java.lang.Class<?>> getTestClass()
        Description copied from interface: TestInfo
        Get the Class associated with the current test or container, if available.
        Specified by:
        getTestClass in interface TestInfo

      • getTestMethod

        public java.util.Optional<java.lang.reflect.Method> getTestMethod()
        Description copied from interface: TestInfo
        Get the Method associated with the current test or container, if available.
        Specified by:
        getTestMethod in interface TestInfo

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • nullSafeGet

        private static java.lang.Object nullSafeGet​(java.util.Optional<?> optional)