Top Description Inners Fields Constructors Methods
org.junit.platform.engine.discovery

public final Class ClasspathResourceSelector

extends Object
implements DiscoverySelector
Class Inheritance
All Implemented Interfaces
org.junit.platform.engine.DiscoverySelector
Annotations
@API
status:STABLE
since:1.0
Static Imports
java.util.Collections.unmodifiableSet, java.util.stream.Collectors.toCollection, org.apiguardian.api.API.Status.DEPRECATED, .API.Status.INTERNAL, .API.Status.MAINTAINED, .API.Status.STABLE

A DiscoverySelector that selects the name of a classpath resource so that TestEngines can load resources from the classpath — for example, to load XML or JSON files from the classpath, potentially within JARs.

Since engines are not expected to modify the classpath, the classpath resource represented by this selector must be on the classpath of the context class loader of the thread that uses it.

Note

Since Java 9, all resources are on the module path. Either in named or unnamed modules. These resources are also considered to be classpath resources.

Since
1.0
See Also
DiscoverySelectors#selectClasspathResource(String), ClasspathRootSelector, getClasspathResourceName()

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
private final String
private final @Nullable FilePosition
private @Nullable Set<Resource>

Constructor Summary

AccessConstructor and Description
pack-priv
ClasspathResourceSelector(String classpathResourceName, @Nullable FilePosition position)

pack-priv
ClasspathResourceSelector(Set<? extends Resource> resources)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object o)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public String
getClasspathResourceName()

Get the name of the selected classpath resource.

public Set<Resource>
getClasspathResources()
Deprecated for removal since 1.14. Please use {getResources()} instead.

Get the selected resources.

public Optional<FilePosition>
getPosition()

Get the selected FilePosition within the classpath resource.

public Set<Resource>
getResources()

Get the selected resources.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public Optional<DiscoverySelectorIdentifier>
toIdentifier()

Overrides default org.junit.platform.engine.DiscoverySelector.toIdentifier.

Return the identifier of this selector.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

classpathResourceNameback to summary
private final String classpathResourceName
positionback to summary
private final @Nullable FilePosition position
resourcesback to summary
private @Nullable Set<Resource> resources

Constructor Detail

ClasspathResourceSelectorback to summary
pack-priv ClasspathResourceSelector(String classpathResourceName, @Nullable FilePosition position)
ClasspathResourceSelectorback to summary
pack-priv ClasspathResourceSelector(Set<? extends Resource> resources)

Method Detail

equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations
@API
status:STABLE
since:1.3
@Override
Since
1.3
getClasspathResourceNameback to summary
public String getClasspathResourceName()

Get the name of the selected classpath resource.

The name of a classpath resource must follow the semantics for resource paths as defined in ClassLoader#getResource(String).

See Also
ClassLoader#getResource(String), ClassLoader#getResourceAsStream(String), ClassLoader#getResources(String)
getClasspathResourcesback to summary
public Set<Resource> getClasspathResources()

Deprecated

for removal since 1.14.

Please use {getResources()} instead.

Get the selected resources.

If the resources were not provided, but only their name, this method attempts to lazily load the resources based on their name and throws a PreconditionViolationException if the resource cannot be loaded.

Annotations
@API
status:DEPRECATED
since:1.14
@Deprecated
since:1.14
forRemoval:true
@SuppressWarnings:removal
Since
1.12
getPositionback to summary
public Optional<FilePosition> getPosition()

Get the selected FilePosition within the classpath resource.

getResourcesback to summary
public Set<Resource> getResources()

Get the selected resources.

If the resources were not provided, but only their name, this method attempts to lazily load the resources based on their name and throws a PreconditionViolationException if the resource cannot be loaded.

Annotations
@API
status:MAINTAINED
since:1.14
Since
1.14
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Annotations
@API
status:STABLE
since:1.3
@Override
Since
1.3
toIdentifierback to summary
public Optional<DiscoverySelectorIdentifier> toIdentifier()

Overrides default org.junit.platform.engine.DiscoverySelector.toIdentifier.

Doc from org.junit.platform.engine.DiscoverySelector.toIdentifier.

Return the identifier of this selector.

The returned identifier must be parsable by a corresponding DiscoverySelectorIdentifierParser.

The default implementation returns Optional#empty(). Can be overridden by concrete implementations.

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations
@Override
org.junit.platform.engine.discovery back to summary

public Class ClasspathResourceSelector.IdentifierParser

extends Object
implements DiscoverySelectorIdentifierParser
Class Inheritance
  • java.lang.Object
  • org.junit.platform.engine.discovery.ClasspathResourceSelector.IdentifierParser
All Implemented Interfaces
org.junit.platform.engine.discovery.DiscoverySelectorIdentifierParser
Annotations
@API
status:INTERNAL
since:1.11

The DiscoverySelectorIdentifierParser for ClasspathResourceSelectors.

Field Summary

Modifier and TypeField and Description
private static final String

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public String
public Optional<ClasspathResourceSelector>
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

PREFIXback to summary
private static final String PREFIX

Constructor Detail

IdentifierParserback to summary
public IdentifierParser()

Method Detail

getPrefixback to summary
public String getPrefix()

Implements org.junit.platform.engine.discovery.DiscoverySelectorIdentifierParser.getPrefix.

Doc from org.junit.platform.engine.discovery.DiscoverySelectorIdentifierParser.getPrefix.

Get the prefix that this parser supports.

Annotations
@Override
parseback to summary
public Optional<ClasspathResourceSelector> parse(DiscoverySelectorIdentifier identifier, DiscoverySelectorIdentifierParser.Context context)

Implements org.junit.platform.engine.discovery.DiscoverySelectorIdentifierParser.parse.

Doc from org.junit.platform.engine.discovery.DiscoverySelectorIdentifierParser.parse.

Parse the supplied DiscoverySelectorIdentifier.

The JUnit Platform will only invoke this method if the supplied DiscoverySelectorIdentifier has a prefix that matches the value returned by getPrefix().

Annotations
@Override