Class DefaultParameterContext
- java.lang.Object
-
- org.junit.jupiter.engine.execution.DefaultParameterContext
-
- All Implemented Interfaces:
ParameterContext
class DefaultParameterContext extends java.lang.Object implements ParameterContext
- Since:
- 5.0
-
-
Constructor Summary
Constructors Constructor Description DefaultParameterContext(java.lang.reflect.Parameter parameter, int index, java.util.Optional<java.lang.Object> target)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description <A extends java.lang.annotation.Annotation>
java.util.Optional<A>findAnnotation(java.lang.Class<A> annotationType)
Find the first annotation ofannotationType
that is either present or meta-present on theParameter
for this context.<A extends java.lang.annotation.Annotation>
java.util.List<A>findRepeatableAnnotations(java.lang.Class<A> annotationType)
Find all repeatable annotations ofannotationType
that are either present or meta-present on theParameter
for this context.int
getIndex()
Get the index of theParameter
for this context within the parameter list of theExecutable
that declares the parameter.java.lang.reflect.Parameter
getParameter()
Get theParameter
for this context.java.util.Optional<java.lang.Object>
getTarget()
Get the target on which theExecutable
that declares theParameter
for this context will be invoked, if available.boolean
isAnnotated(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)
Determine if an annotation ofannotationType
is either present or meta-present on theParameter
for this context.java.lang.String
toString()
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.junit.jupiter.api.extension.ParameterContext
getDeclaringExecutable
-
-
-
-
Method Detail
-
getParameter
public java.lang.reflect.Parameter getParameter()
Description copied from interface:ParameterContext
Get theParameter
for this context.WARNING
When searching for annotations on the parameter in this context, favor
ParameterContext.isAnnotated(Class)
,ParameterContext.findAnnotation(Class)
, andParameterContext.findRepeatableAnnotations(Class)
over methods in theParameter
API due to a bug injavac
on JDK versions prior to JDK 9.- Specified by:
getParameter
in interfaceParameterContext
- Returns:
- the parameter; never
null
- See Also:
ParameterContext.getIndex()
-
getIndex
public int getIndex()
Description copied from interface:ParameterContext
Get the index of theParameter
for this context within the parameter list of theExecutable
that declares the parameter.- Specified by:
getIndex
in interfaceParameterContext
- Returns:
- the index of the parameter
- See Also:
ParameterContext.getParameter()
,Executable.getParameters()
-
getTarget
public java.util.Optional<java.lang.Object> getTarget()
Description copied from interface:ParameterContext
Get the target on which theExecutable
that declares theParameter
for this context will be invoked, if available.- Specified by:
getTarget
in interfaceParameterContext
- Returns:
- an
Optional
containing the target on which theExecutable
will be invoked; nevernull
but will be empty if theExecutable
is a constructor or astatic
method.
-
isAnnotated
public boolean isAnnotated(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)
Description copied from interface:ParameterContext
Determine if an annotation ofannotationType
is either present or meta-present on theParameter
for this context.WARNING
Favor the use of this method over directly invoking
AnnotatedElement.isAnnotationPresent(Class)
due to a bug injavac
on JDK versions prior to JDK 9.- Specified by:
isAnnotated
in interfaceParameterContext
- Parameters:
annotationType
- the annotation type to search for; nevernull
- Returns:
true
if the annotation is present or meta-present- See Also:
ParameterContext.findAnnotation(Class)
,ParameterContext.findRepeatableAnnotations(Class)
-
findAnnotation
public <A extends java.lang.annotation.Annotation> java.util.Optional<A> findAnnotation(java.lang.Class<A> annotationType)
Description copied from interface:ParameterContext
Find the first annotation ofannotationType
that is either present or meta-present on theParameter
for this context.WARNING
Favor the use of this method over directly invoking annotation lookup methods in the
Parameter
API due to a bug injavac
on JDK versions prior to JDK 9.- Specified by:
findAnnotation
in interfaceParameterContext
- Type Parameters:
A
- the annotation type- Parameters:
annotationType
- the annotation type to search for; nevernull
- Returns:
- an
Optional
containing the annotation; nevernull
but potentially empty - See Also:
ParameterContext.isAnnotated(Class)
,ParameterContext.findRepeatableAnnotations(Class)
-
findRepeatableAnnotations
public <A extends java.lang.annotation.Annotation> java.util.List<A> findRepeatableAnnotations(java.lang.Class<A> annotationType)
Description copied from interface:ParameterContext
Find all repeatable annotations ofannotationType
that are either present or meta-present on theParameter
for this context.WARNING
Favor the use of this method over directly invoking annotation lookup methods in the
Parameter
API due to a bug injavac
on JDK versions prior to JDK 9.- Specified by:
findRepeatableAnnotations
in interfaceParameterContext
- Type Parameters:
A
- the annotation type- Parameters:
annotationType
- the repeatable annotation type to search for; nevernull
- Returns:
- the list of all such annotations found; neither
null
nor mutable, but potentially empty - See Also:
ParameterContext.isAnnotated(Class)
,ParameterContext.findAnnotation(Class)
,Repeatable
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-