-
- Type Parameters:
T
- the type of the payload
@API(status=STABLE, since="5.8") public interface Named<T>
Named
is a container that associates a name with a given payload.- Since:
- 5.8
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getName()
Get the name of the payload.T
getPayload()
Get the payload.static <T> Named<T>
named(java.lang.String name, T payload)
Factory method for creating an instance ofNamed
based on aname
and apayload
.static <T> Named<T>
of(java.lang.String name, T payload)
Factory method for creating an instance ofNamed
based on aname
and apayload
.
-
-
-
Method Detail
-
of
static <T> Named<T> of(java.lang.String name, T payload)
Factory method for creating an instance ofNamed
based on aname
and apayload
.- Type Parameters:
T
- the type of the payload- Parameters:
name
- the name associated with the payload; nevernull
or blankpayload
- the object that serves as the payload; may benull
depending on the use case- Returns:
- an instance of
Named
; nevernull
- See Also:
named(String, java.lang.Object)
-
named
static <T> Named<T> named(java.lang.String name, T payload)
Factory method for creating an instance ofNamed
based on aname
and apayload
.This method is an alias for
of(java.lang.String, T)
and is intended to be used when statically imported — for example, via:import static org.junit.jupiter.api.Named.named;
- Type Parameters:
T
- the type of the payload- Parameters:
name
- the name associated with the payload; nevernull
or blankpayload
- the object that serves as the payload; may benull
depending on the use case- Returns:
- an instance of
Named
; nevernull
-
getName
java.lang.String getName()
Get the name of the payload.- Returns:
- the name of the payload; never
null
or blank
-
getPayload
T getPayload()
Get the payload.- Returns:
- the payload; may be
null
depending on the use case
-
-