SmallRye Common 2.10.0 · io.smallrye.common.classloader.ClassPathUtils

Modifier and Type	Field and Description
private static final String	FILE
private static final String	JAR
private static final FileSystemProvider	JAR_PROVIDER

Access	Constructor and Description
private	ClassPathUtils()

Method Summary

Modifier and Type	Method and Description
public static void	consumeAsPath(URL resource url url, Consumer<Path> resource path consumer consumer) Attempts to represent a resource as a local file system path to be processed by a consumer.
public static void	consumeAsPaths(String resource path resource, Consumer<Path> resource path consumer consumer) Invokes `consumeAsPaths(ClassLoader, String, Consumer)` passing in an instance of the current thread's context classloader as the classloader from which to load the resources.
public static void	consumeAsPaths(ClassLoader classloader to load the resources from cl, String resource path resource, Consumer<Path> resource path consumer consumer) Locates specified resources on the classpath and attempts to represent them as local file system paths to be processed by a consumer.
public static void	consumeAsStreams(String resource path resource, Consumer<InputStream> resource input stream consumer consumer) Invokes `consumeAsStreams(ClassLoader, String, Consumer)` passing in an instance of the current thread's context classloader as the classloader from which to load the resources.
public static void	consumeAsStreams(ClassLoader classloader to load the resources from cl, String resource path resource, Consumer<InputStream> resource input stream consumer consumer) Locates all the occurrences of a resource on the classpath of the provided classloader and invokes the consumer providing the input streams for each located resource.
public static void	consumeStream(URL URL url, Consumer<InputStream> input stream consumer consumer) Invokes a consumer providing the input streams to read the content of the URL.
private static <R> R	processAsJarPath(Path jarPath, String path, Function<Path, R> function)
public static < the result type R> R	Returns: the result of the function processAsPath(URL resource url url, Function<Path, R> resource path function function) Attempts to represent a resource as a local file system path to be processed by a function.
public static < the result type R> R	Returns: the result of the function readStream(URL URL url, Function<InputStream, R> input stream processing function function) Invokes a function providing the input streams to read the content of the URL.
public static Path	Returns: local file system path toLocalPath(final URL URL url) Translates a URL to local file system path.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

FILE	back to summary
private static final String FILE

JAR	back to summary
private static final String JAR

JAR_PROVIDER	back to summary
private static final FileSystemProvider JAR_PROVIDER

ClassPathUtils	back to summary
private ClassPathUtils()

Method Detail

consumeAsPath back to summary

consumeAsPath	back to summary
public static void consumeAsPath(URL url, Consumer<Path> consumer) Attempts to represent a resource as a local file system path to be processed by a consumer. If a resource appears to be an actual file or a directory, it is simply passed to the consumer as-is. If a resource is an entry in a JAR, the entry will be resolved as an instance of `java.nio.file.Path` in a `java.nio.file.FileSystem` representing the JAR. If the protocol of the URL representing the resource is neither 'file' nor 'jar', the method will fail with an exception. Parameters url:URL resource url consumer:Consumer<Path> resource path consumer

public static void consumeAsPath(URL url, Consumer<Path> consumer)

Attempts to represent a resource as a local file system path to be processed by a consumer. If a resource appears to be an actual file or a directory, it is simply passed to the consumer as-is. If a resource is an entry in a JAR, the entry will be resolved as an instance of java.nio.file.Path in a java.nio.file.FileSystem representing the JAR. If the protocol of the URL representing the resource is neither 'file' nor 'jar', the method will fail with an exception.

Parameters

url:URL: resource url
consumer:Consumer<Path>: resource path consumer

consumeAsPaths back to summary

consumeAsPaths	back to summary
public static void consumeAsPaths(String resource, Consumer<Path> consumer) throws IOException Invokes `consumeAsPaths(ClassLoader, String, Consumer)` passing in an instance of the current thread's context classloader as the classloader from which to load the resources. Parameters resource:String resource path consumer:Consumer<Path> resource path consumer Exceptions IOException: in case of an IO failure

public static void consumeAsPaths(String resource, Consumer<Path> consumer) throws IOException

Invokes consumeAsPaths(ClassLoader, String, Consumer) passing in an instance of the current thread's context classloader as the classloader from which to load the resources.

Parameters

resource:String: resource path
consumer:Consumer<Path>: resource path consumer

Exceptions

IOException:: in case of an IO failure

consumeAsPaths back to summary

consumeAsPaths	back to summary
public static void consumeAsPaths(ClassLoader cl, String resource, Consumer<Path> consumer) throws IOException Locates specified resources on the classpath and attempts to represent them as local file system paths to be processed by a consumer. If a resource appears to be an actual file or a directory, it is simply passed to the consumer as-is. If a resource is an entry in a JAR, the entry will be resolved as an instance of `java.nio.file.Path` in a `java.nio.file.FileSystem` representing the JAR. If the protocol of the URL representing the resource is neither 'file' nor 'jar', the method will fail with an exception. Parameters cl:ClassLoader classloader to load the resources from resource:String resource path consumer:Consumer<Path> resource path consumer Exceptions IOException: in case of an IO failure

public static void consumeAsPaths(ClassLoader cl, String resource, Consumer<Path> consumer) throws IOException

Locates specified resources on the classpath and attempts to represent them as local file system paths to be processed by a consumer. If a resource appears to be an actual file or a directory, it is simply passed to the consumer as-is. If a resource is an entry in a JAR, the entry will be resolved as an instance of java.nio.file.Path in a java.nio.file.FileSystem representing the JAR. If the protocol of the URL representing the resource is neither 'file' nor 'jar', the method will fail with an exception.

Parameters

cl:ClassLoader: classloader to load the resources from
resource:String: resource path
consumer:Consumer<Path>: resource path consumer

Exceptions

IOException:: in case of an IO failure

consumeAsStreams back to summary

consumeAsStreams	back to summary
public static void consumeAsStreams(String resource, Consumer<InputStream> consumer) throws IOException Invokes `consumeAsStreams(ClassLoader, String, Consumer)` passing in an instance of the current thread's context classloader as the classloader from which to load the resources. Parameters resource:String resource path consumer:Consumer<InputStream> resource input stream consumer Exceptions IOException: in case of an IO failure

public static void consumeAsStreams(String resource, Consumer<InputStream> consumer) throws IOException

Invokes consumeAsStreams(ClassLoader, String, Consumer) passing in an instance of the current thread's context classloader as the classloader from which to load the resources.

Parameters

resource:String: resource path
consumer:Consumer<InputStream>: resource input stream consumer

Exceptions

IOException:: in case of an IO failure

consumeAsStreams back to summary

consumeAsStreams	back to summary
public static void consumeAsStreams(ClassLoader cl, String resource, Consumer<InputStream> consumer) throws IOException Locates all the occurrences of a resource on the classpath of the provided classloader and invokes the consumer providing the input streams for each located resource. The consumer does not have to close the provided input stream. This method was introduced to avoid calling `java.net.URL#openStream()` which in case the resource is found in an archive (such as JAR) locks the containing archive even if the caller properly closes the stream. Parameters cl:ClassLoader classloader to load the resources from resource:String resource path consumer:Consumer<InputStream> resource input stream consumer Exceptions IOException: in case of an IO failure

public static void consumeAsStreams(ClassLoader cl, String resource, Consumer<InputStream> consumer) throws IOException

Locates all the occurrences of a resource on the classpath of the provided classloader and invokes the consumer providing the input streams for each located resource. The consumer does not have to close the provided input stream. This method was introduced to avoid calling java.net.URL#openStream() which in case the resource is found in an archive (such as JAR) locks the containing archive even if the caller properly closes the stream.

Parameters

cl:ClassLoader: classloader to load the resources from
resource:String: resource path
consumer:Consumer<InputStream>: resource input stream consumer

Exceptions

IOException:: in case of an IO failure

consumeStream back to summary

consumeStream	back to summary
public static void consumeStream(URL url, Consumer<InputStream> consumer) throws IOException Invokes a consumer providing the input streams to read the content of the URL. The consumer does not have to close the provided input stream. This method was introduced to avoid calling `java.net.URL#openStream()` which in case the resource is found in an archive (such as JAR) locks the containing archive even if the caller properly closes the stream. Parameters url:URL URL consumer:Consumer<InputStream> input stream consumer Exceptions IOException: in case of an IO failure

public static void consumeStream(URL url, Consumer<InputStream> consumer) throws IOException

Invokes a consumer providing the input streams to read the content of the URL. The consumer does not have to close the provided input stream. This method was introduced to avoid calling java.net.URL#openStream() which in case the resource is found in an archive (such as JAR) locks the containing archive even if the caller properly closes the stream.

Parameters

url:URL: URL
consumer:Consumer<InputStream>: input stream consumer

Exceptions

IOException:: in case of an IO failure

processAsJarPath	back to summary
private static <R> R processAsJarPath(Path jarPath, String path, Function<Path, R> function)

processAsPath back to summary

processAsPath	back to summary
public static <R> R processAsPath(URL url, Function<Path, R> function) Attempts to represent a resource as a local file system path to be processed by a function. If a resource appears to be an actual file or a directory, it is simply passed to the function as-is. If a resource is an entry in a JAR, the entry will be resolved as an instance of `java.nio.file.Path` in a `java.nio.file.FileSystem` representing the JAR. If the protocol of the URL representing the resource is neither 'file' nor 'jar', the method will fail with an exception. Parameters <R> the result type url:URL resource url function:Function<Path, R> resource path function Returns:R the result of the function

public static <R> R processAsPath(URL url, Function<Path, R> function)

Attempts to represent a resource as a local file system path to be processed by a function. If a resource appears to be an actual file or a directory, it is simply passed to the function as-is. If a resource is an entry in a JAR, the entry will be resolved as an instance of java.nio.file.Path in a java.nio.file.FileSystem representing the JAR. If the protocol of the URL representing the resource is neither 'file' nor 'jar', the method will fail with an exception.

Parameters

<R>: the result type
url:URL: resource url
function:Function<Path, R>: resource path function

Returns:R

the result of the function

readStream back to summary

readStream	back to summary
public static <R> R readStream(URL url, Function<InputStream, R> function) throws IOException Invokes a function providing the input streams to read the content of the URL. The function does not have to close the provided input stream. This method was introduced to avoid calling `java.net.URL#openStream()` directly, which in case the resource is found in an archive (such as JAR) locks the containing archive even if the caller properly closes the stream. Parameters <R> the result type url:URL URL function:Function<InputStream, R> input stream processing function Returns:R the result of the function Exceptions IOException: in case of an IO failure

public static <R> R readStream(URL url, Function<InputStream, R> function) throws IOException

Invokes a function providing the input streams to read the content of the URL. The function does not have to close the provided input stream. This method was introduced to avoid calling java.net.URL#openStream() directly, which in case the resource is found in an archive (such as JAR) locks the containing archive even if the caller properly closes the stream.

Parameters

<R>: the result type
url:URL: URL
function:Function<InputStream, R>: input stream processing function

Returns:R

the result of the function

Exceptions

IOException:: in case of an IO failure

toLocalPath back to summary

toLocalPath	back to summary
public static Path toLocalPath(final URL url) Translates a URL to local file system path. In case the URL couldn't be translated to a file system path, an instance of `IllegalArgumentException` will be thrown. Parameters url:URL URL Returns:Path local file system path

public static Path toLocalPath(final URL url)

Translates a URL to local file system path. In case the URL couldn't be translated to a file system path, an instance of IllegalArgumentException will be thrown.

Parameters

url:URL: URL

Returns:Path

local file system path

public Class ClassPathUtils

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail