Package org.junit.runners.model

Class FrameworkMethod

  • All Implemented Interfaces:
    Annotatable
    public class FrameworkMethod
extends FrameworkMember<FrameworkMethod>
    Represents a method on a test class to be invoked at the appropriate point in test execution. These methods are usually marked with an annotation (such as @Test, @Before, @After, @BeforeClass, @AfterClass, etc.)
    Since:
    4.5

    • Constructor Summary

      Constructors 
      Constructor Description
      FrameworkMethod​(java.lang.reflect.Method method)
      Returns a new FrameworkMethod for method

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      <T extends java.lang.annotation.Annotation>
      T      		 getAnnotation​(java.lang.Class<T> annotationType)
      Returns the annotation of type annotationType on this method, if one exists.
      java.lang.annotation.Annotation[] getAnnotations()
      Returns the annotations on this method
      java.lang.Class<?> getDeclaringClass()
      Returns the class where the method is actually declared
      java.lang.reflect.Method getMethod()
      Returns the underlying Java method
      protected int getModifiers()  
      java.lang.String getName()
      Returns the method's name
      java.lang.Class<?> getReturnType()
      Returns the return type of the method
      java.lang.Class<?> getType()
      Returns the return type of the method
      int hashCode()  
      java.lang.Object invokeExplosively​(java.lang.Object target, java.lang.Object... params)
      Returns the result of invoking this method on target with parameters params.
      boolean isShadowedBy​(FrameworkMethod other)  
      boolean producesType​(java.lang.reflect.Type type)
      Deprecated.
      This is used only by the Theories runner, and does not use all the generic type info that it ought to.
      java.lang.String toString()  
      void validateNoTypeParametersOnArgs​(java.util.List<java.lang.Throwable> errors)  
      void validatePublicVoid​(boolean isStatic, java.util.List<java.lang.Throwable> errors)
      Adds to errors if this method: is not public, or returns something other than void, or is static (given isStatic is false), or is not static (given isStatic is true).
      void validatePublicVoidNoArg​(boolean isStatic, java.util.List<java.lang.Throwable> errors)
      Adds to errors if this method: is not public, or takes parameters, or returns something other than void, or is static (given isStatic is false), or is not static (given isStatic is true).

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • FrameworkMethod

        public FrameworkMethod​(java.lang.reflect.Method method)
        Returns a new FrameworkMethod for method

    • Method Detail

      • getMethod

        public java.lang.reflect.Method getMethod()
        Returns the underlying Java method

      • invokeExplosively

        public java.lang.Object invokeExplosively​(java.lang.Object target,
                                          java.lang.Object... params)
                                   throws java.lang.Throwable
        Returns the result of invoking this method on target with parameters params. InvocationTargetExceptions thrown are unwrapped, and their causes rethrown.
        Throws:
        java.lang.Throwable

      • validatePublicVoidNoArg

        public void validatePublicVoidNoArg​(boolean isStatic,
                                    java.util.List<java.lang.Throwable> errors)
        Adds to errors if this method:
        • is not public, or
        • takes parameters, or
        • returns something other than void, or
        • is static (given isStatic is false), or
        • is not static (given isStatic is true).

      • validatePublicVoid

        public void validatePublicVoid​(boolean isStatic,
                               java.util.List<java.lang.Throwable> errors)
        Adds to errors if this method:
        • is not public, or
        • returns something other than void, or
        • is static (given isStatic is false), or
        • is not static (given isStatic is true).

      • getReturnType

        public java.lang.Class<?> getReturnType()
        Returns the return type of the method

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • producesType

        @Deprecated
public boolean producesType​(java.lang.reflect.Type type)
        Deprecated.
        This is used only by the Theories runner, and does not use all the generic type info that it ought to. It will be replaced with a forthcoming ParameterSignature#canAcceptResultOf(FrameworkMethod) once Theories moves to junit-contrib.
        Returns true if this is a no-arg method that returns a value assignable to type

      • getAnnotations

        public java.lang.annotation.Annotation[] getAnnotations()
        Returns the annotations on this method

      • getAnnotation

        public <T extends java.lang.annotation.Annotation> T getAnnotation​(java.lang.Class<T> annotationType)
        Returns the annotation of type annotationType on this method, if one exists.

      • toString

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