java.lang.Object
- com.google.common.reflect.ClassPath

```
public final class ClassPath
extends java.lang.Object
```
Scans the source of a ClassLoader and finds all loadable classes and resources.
Warning: Current limitations:
- Looks only for files and JARs in URLs available from URLClassLoader instances or the system class loader.
- Only understands file: URLs.
In the case of directory classloaders, symlinks are supported but cycles are not traversed. This guarantees discovery of each unique loadable resource. However, not all possible aliases for resources on cyclic paths will be listed.
Since:

14.0

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`ClassPath.ClassInfo`	Represents a class that can be loaded through `ClassPath.ClassInfo.load()`.
`(package private) static class`	`ClassPath.LocationInfo`	Represents a single location (a directory or a jar file) in the class path and is responsible for scanning resources from this location.
`static class`	`ClassPath.ResourceInfo`	Represents a class path resource that can be either a class file or any other resource file loadable from the class path.

Field Summary

Fields
Modifier and Type	Field	Description
`private static java.lang.String`	`CLASS_FILE_NAME_EXTENSION`
`private static Splitter`	`CLASS_PATH_ATTRIBUTE_SEPARATOR`	Separator for the Class-Path manifest attribute value in jar files.
`private static java.util.logging.Logger`	`logger`
`private ImmutableSet<ClassPath.ResourceInfo>`	`resources`

Constructor Summary

Constructors
Modifier Constructor Description

private ClassPath(ImmutableSet<ClassPath.ResourceInfo> resources)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ClassPath`	`from(java.lang.ClassLoader classloader)`	Returns a `ClassPath` representing all classes and resources loadable from `classloader` and its ancestor class loaders.
`ImmutableSet<ClassPath.ClassInfo>`	`getAllClasses()`	Returns all classes loadable from the current class path.
`private static ImmutableList<java.net.URL>`	`getClassLoaderUrls(java.lang.ClassLoader classloader)`
`(package private) static java.lang.String`	`getClassName(java.lang.String filename)`
`(package private) static ImmutableMap<java.io.File,java.lang.ClassLoader>`	`getClassPathEntries(java.lang.ClassLoader classloader)`
`(package private) static java.net.URL`	`getClassPathEntry(java.io.File jarFile, java.lang.String path)`	Returns the absolute uri of the Class-Path entry value as specified in JAR File Specification.
`(package private) static ImmutableSet<java.io.File>`	`getClassPathFromManifest(java.io.File jarFile, java.util.jar.Manifest manifest)`	Returns the class path URIs specified by the `Class-Path` manifest attribute, according to JAR File Specification.
`ImmutableSet<ClassPath.ResourceInfo>`	`getResources()`	Returns all resources loadable from the current class path, including the class files of all loadable classes but excluding the "META-INF/MANIFEST.MF" file.
`ImmutableSet<ClassPath.ClassInfo>`	`getTopLevelClasses()`	Returns all top level classes loadable from the current class path.
`ImmutableSet<ClassPath.ClassInfo>`	`getTopLevelClasses(java.lang.String packageName)`	Returns all top level classes whose package name is `packageName`.
`ImmutableSet<ClassPath.ClassInfo>`	`getTopLevelClassesRecursive(java.lang.String packageName)`	Returns all top level classes whose package name is `packageName` or starts with `packageName` followed by a '.'.
`(package private) static ImmutableSet<ClassPath.LocationInfo>`	`locationsFrom(java.lang.ClassLoader classloader)`	Returns all locations that `classloader` and parent loaders load classes and resources from.
`(package private) static ImmutableList<java.net.URL>`	`parseJavaClassPath()`	Returns the URLs in the class path specified by the `java.class.path` system property.
`(package private) static java.io.File`	`toFile(java.net.URL url)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - logger
```
private static final java.util.logging.Logger logger
```
  - CLASS_PATH_ATTRIBUTE_SEPARATOR
```
private static final Splitter CLASS_PATH_ATTRIBUTE_SEPARATOR
```
    Separator for the Class-Path manifest attribute value in jar files.
  - CLASS_FILE_NAME_EXTENSION
```
private static final java.lang.String CLASS_FILE_NAME_EXTENSION
```
    See Also:
    
    Constant Field Values
  - resources
```
private final ImmutableSet<ClassPath.ResourceInfo> resources
```
- Constructor Detail
  - ClassPath
```
private ClassPath(ImmutableSet<ClassPath.ResourceInfo> resources)
```
- Method Detail
  - from
```
public static ClassPath from(java.lang.ClassLoader classloader)
                      throws java.io.IOException
```
    Returns a ClassPath representing all classes and resources loadable from classloader and its ancestor class loaders.
    Warning: ClassPath can find classes and resources only from:
    
    URLClassLoader instances' file: URLs
    the system class loader. To search the system class loader even when it is not a URLClassLoader (as in Java 9), ClassPath searches the files from the java.class.path system property.
    Throws:
    
    java.io.IOException - if the attempt to read class path resources (jar files or directories) failed.
  - getResources
```
public ImmutableSet<ClassPath.ResourceInfo> getResources()
```
    Returns all resources loadable from the current class path, including the class files of all loadable classes but excluding the "META-INF/MANIFEST.MF" file.
  - getAllClasses
```
public ImmutableSet<ClassPath.ClassInfo> getAllClasses()
```
    Returns all classes loadable from the current class path.
    
    Since:
    
    16.0
  - getTopLevelClasses
```
public ImmutableSet<ClassPath.ClassInfo> getTopLevelClasses()
```
    Returns all top level classes loadable from the current class path. Note that "top-level-ness" is determined heuristically by class name (see ClassPath.ClassInfo.isTopLevel()).
  - getTopLevelClasses
```
public ImmutableSet<ClassPath.ClassInfo> getTopLevelClasses(java.lang.String packageName)
```
    Returns all top level classes whose package name is packageName.
  - getTopLevelClassesRecursive
```
public ImmutableSet<ClassPath.ClassInfo> getTopLevelClassesRecursive(java.lang.String packageName)
```
    Returns all top level classes whose package name is packageName or starts with packageName followed by a '.'.
  - locationsFrom
```
static ImmutableSet<ClassPath.LocationInfo> locationsFrom(java.lang.ClassLoader classloader)
```
    Returns all locations that classloader and parent loaders load classes and resources from. Callers can scan individual locations selectively or even in parallel.
  - getClassPathFromManifest
```
static ImmutableSet<java.io.File> getClassPathFromManifest(java.io.File jarFile,
                                                           java.util.jar.Manifest manifest)
```
    Returns the class path URIs specified by the Class-Path manifest attribute, according to JAR File Specification. If manifest is null, it means the jar file has no manifest, and an empty set will be returned.
  - getClassPathEntries
```
static ImmutableMap<java.io.File,java.lang.ClassLoader> getClassPathEntries(java.lang.ClassLoader classloader)
```
  - getClassLoaderUrls
```
private static ImmutableList<java.net.URL> getClassLoaderUrls(java.lang.ClassLoader classloader)
```
  - parseJavaClassPath
```
static ImmutableList<java.net.URL> parseJavaClassPath()
```
    Returns the URLs in the class path specified by the java.class.path system property.
  - getClassPathEntry
```
static java.net.URL getClassPathEntry(java.io.File jarFile,
                                      java.lang.String path)
                               throws java.net.MalformedURLException
```
    Returns the absolute uri of the Class-Path entry value as specified in JAR File Specification. Even though the specification only talks about relative urls, absolute urls are actually supported too (for example, in Maven surefire plugin).
    
    Throws:
    
    java.net.MalformedURLException
  - getClassName
```
static java.lang.String getClassName(java.lang.String filename)
```
  - toFile
```
static java.io.File toFile(java.net.URL url)
```

Class ClassPath

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

logger

CLASS_PATH_ATTRIBUTE_SEPARATOR

CLASS_FILE_NAME_EXTENSION

resources

Constructor Detail

ClassPath

Method Detail

from

getResources

getAllClasses

getTopLevelClasses

getTopLevelClasses

getTopLevelClassesRecursive

locationsFrom

getClassPathFromManifest

getClassPathEntries

getClassLoaderUrls

parseJavaClassPath

getClassPathEntry

getClassName

toFile