io microsphere util ClassPathUtils

ClassPathUtils

Type: Class | Module: microsphere-java-core | Package: io.microsphere.util | Since: 1.0.0

Source: microsphere-java-core/src/main/java/io/microsphere/util/ClassPathUtils.java

Overview

ClassPathUtils is an abstract utility class that provides methods for retrieving various class path-related information.

Key Features:

- Retrieving bootstrap class paths
- Retrieving application class paths
- Locating the runtime URL of a class by name or type

Example Usage

`// Get all application class paths
Set classPaths = ClassPathUtils.getClassPaths();
for (String path : classPaths) {
    System.out.println("ClassPath: " + path);
`

// Get the location of a specific class
URL location = ClassPathUtils.getRuntimeClassLocation(io.microsphere.util.ClassPathUtils.class);
if (location != null) {
    System.out.println("Class Location: " + location);
}
}

Declaration

public abstract class ClassPathUtils implements Utils

Author: Mercy

Version Information

• Introduced in: 1.0.0
• Current Project Version: 0.3.20-SNAPSHOT

Version Compatibility

This component is tested and compatible with the following Java versions:

Java Version	Status
Java 8	✅ Compatible
Java 11	✅ Compatible
Java 17	✅ Compatible
Java 21	✅ Compatible
Java 25	✅ Compatible

Examples

// Get all application class paths
Set<String> classPaths = ClassPathUtils.getClassPaths();
for (String path : classPaths) {
    System.out.println("ClassPath: " + path);
}

// Get the location of a specific class
URL location = ClassPathUtils.getRuntimeClassLocation(io.microsphere.util.ClassPathUtils.class);
if (location != null) {
    System.out.println("Class Location: " + location);
}

Method Examples

getBootstrapClassPaths

Set<String> paths = ClassPathUtils.resolveClassPaths(true, () -> "/lib/a.jar:/lib/b.jar");
  // paths contains ["/lib/a.jar", "/lib/b.jar"]

  Set<String> empty = ClassPathUtils.resolveClassPaths(false, () -> "");
  // empty set returned when not supported

Set<String> bootClassPaths = ClassPathUtils.getBootstrapClassPaths();
for (String path : bootClassPaths) {
    System.out.println("Bootstrap ClassPath: " + path);
}

getClassPaths

Set<String> classPaths = ClassPathUtils.getClassPaths();
for (String path : classPaths) {
    System.out.println("ClassPath: " + path);
}

getRuntimeClassLocation

String className = "io.microsphere.util.ClassPathUtils";
URL classLocation = ClassPathUtils.getRuntimeClassLocation(className);
if (classLocation != null) {
    System.out.println("Class Location: " + classLocation);
} else {
    System.out.println("Class not found or not loadable.");
}

getRuntimeClassLocation

Class<?> type = io.microsphere.util.ClassPathUtils.class;
URL classLocation = ClassPathUtils.getRuntimeClassLocation(type);
if (classLocation != null) {
    System.out.println("Class Location: " + classLocation);
} else {
    System.out.println("Class location could not be determined.");
}

Usage

Maven Dependency

Add the following dependency to your pom.xml:

<dependency>
    <groupId>io.github.microsphere-projects</groupId>
    <artifactId>microsphere-java-core</artifactId>
    <version>${microsphere-java.version}</version>
</dependency>

Tip: Use the BOM (microsphere-java-dependencies) for consistent version management. See the Getting Started guide.

Import

import io.microsphere.util.ClassPathUtils;

API Reference

Public Methods

Method	Description
getBootstrapClassPaths	Resolves class paths from the given supplier if class path is supported.
getClassPaths	Returns the set of application class paths.
getRuntimeClassLocation	Get Class Location URL from specified class name at runtime.
getRuntimeClassLocation	Get Class Location URL from specified Class at runtime.

Method Details

getBootstrapClassPaths

public static Set<String> getBootstrapClassPaths()

Resolves class paths from the given supplier if class path is supported.

Example Usage

`Set paths = ClassPathUtils.resolveClassPaths(true, () -> "/lib/a.jar:/lib/b.jar");
  // paths contains ["/lib/a.jar", "/lib/b.jar"]

  Set empty = ClassPathUtils.resolveClassPaths(false, () -> "");
  // empty set returned when not supported
`

getClassPaths

public static Set<String> getClassPaths()

Returns the set of application class paths.

This method provides access to the class paths used by the Java runtime for loading application classes.

Example Usage

`Set classPaths = ClassPathUtils.getClassPaths();
for (String path : classPaths) {
    System.out.println("ClassPath: " + path);
`
}

getRuntimeClassLocation

public static URL getRuntimeClassLocation(@Nullable String className)

Get Class Location URL from specified class name at runtime.

If the class associated with the provided className is loaded by the default class loader (see ClassLoaderUtils#getDefaultClassLoader()), this method returns the location URL of that class. Otherwise, it returns null.

Example Usage

`String className = "io.microsphere.util.ClassPathUtils";
URL classLocation = ClassPathUtils.getRuntimeClassLocation(className);
if (classLocation != null) {
    System.out.println("Class Location: " + classLocation);
` else {
    System.out.println("Class not found or not loadable.");
}
}

getRuntimeClassLocation

public static URL getRuntimeClassLocation(@Nonnull Class<?> type)

Get Class Location URL from specified Class at runtime.

This method determines the location (URL) from which the provided class was loaded. If the class is a primitive type, array type, or synthetic type, or if a security manager prevents access to the protection domain, this method returns null.

Example Usage

`Class type = io.microsphere.util.ClassPathUtils.class;
URL classLocation = ClassPathUtils.getRuntimeClassLocation(type);
if (classLocation != null) {
    System.out.println("Class Location: " + classLocation);
` else {
    System.out.println("Class location could not be determined.");
}
}

See Also

• ClassPathUtils

---

This documentation was auto-generated from the source code of microsphere-java.