Modifier and Type	Class and Description
public static class	ClassPath.ClassInfo Represents a class that can be loaded through `load`.
pack-priv 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.
public 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.

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

Access	Constructor and Description
private	ClassPath(ImmutableSet<ClassPath.ResourceInfo> resources)

Method Summary

Modifier and Type	Method and Description
public static ClassPath	from(ClassLoader classloader) Returns a `ClassPath` representing all classes and resources loadable from `classloader` and its ancestor class loaders.
public ImmutableSet<ClassPath.ClassInfo>	getAllClasses() Returns all classes loadable from the current class path.
private static ImmutableList<URL>	getClassLoaderUrls(ClassLoader classloader)
pack-priv static String	getClassName(String filename)
pack-priv static ImmutableMap<File, ClassLoader>	getClassPathEntries(ClassLoader classloader)
pack-priv static URL	getClassPathEntry(File jarFile, String path) Returns the absolute uri of the Class-Path entry value as specified in JAR File Specification.
pack-priv static ImmutableSet<File>	getClassPathFromManifest(File jarFile, Manifest manifest) Returns the class path URIs specified by the `Class-Path` manifest attribute, according to JAR File Specification.
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.
public ImmutableSet<ClassPath.ClassInfo>	getTopLevelClasses() Returns all top level classes loadable from the current class path.
public ImmutableSet<ClassPath.ClassInfo>	getTopLevelClasses(String packageName) Returns all top level classes whose package name is `packageName`.
public ImmutableSet<ClassPath.ClassInfo>	getTopLevelClassesRecursive(String packageName) Returns all top level classes whose package name is `packageName` or starts with `packageName` followed by a '.'.
pack-priv static ImmutableSet<ClassPath.LocationInfo>	locationsFrom(ClassLoader classloader) Returns all locations that `classloader` and parent loaders load classes and resources from.
pack-priv static ImmutableList<URL>	parseJavaClassPath() Returns the URLs in the class path specified by the `java.class.path` system property.
pack-priv static File	toFile(URL url)

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

CLASS_FILE_NAME_EXTENSION	back to summary
private static final String CLASS_FILE_NAME_EXTENSION

CLASS_PATH_ATTRIBUTE_SEPARATOR	back to summary
private static final Splitter CLASS_PATH_ATTRIBUTE_SEPARATOR Separator for the Class-Path manifest attribute value in jar files.

logger	back to summary
private static final Logger logger

resources	back to summary
private final ImmutableSet<ClassPath.ResourceInfo> resources

ClassPath	back to summary
private ClassPath(ImmutableSet<ClassPath.ResourceInfo> resources)

Method Detail

from back to summary

from	back to summary
public static ClassPath from(ClassLoader classloader) throws 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. Exceptions IOException: if the attempt to read class path resources (jar files or directories) failed.

public static ClassPath from(ClassLoader classloader) throws 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.

Exceptions

IOException:: if the attempt to read class path resources (jar files or directories) failed.

getAllClasses	back to summary
public ImmutableSet<ClassPath.ClassInfo> getAllClasses() Returns all classes loadable from the current class path. Since 16.0

getAllClasses

back to summary

public ImmutableSet<ClassPath.ClassInfo> getAllClasses()

Returns all classes loadable from the current class path.

Since: 16.0

getClassLoaderUrls	back to summary
private static ImmutableList<URL> getClassLoaderUrls(ClassLoader classloader)

getClassName	back to summary
pack-priv static String getClassName(String filename) Annotations @VisibleForTesting

getClassPathEntries	back to summary
pack-priv static ImmutableMap<File, ClassLoader> getClassPathEntries(ClassLoader classloader) Annotations @VisibleForTesting

getClassPathEntry	back to summary
pack-priv static URL getClassPathEntry(File jarFile, String path) throws 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). Annotations @VisibleForTesting

getClassPathEntry

back to summary

pack-priv static URL getClassPathEntry(File jarFile, String path) throws 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).

Annotations

@VisibleForTesting

getClassPathFromManifest back to summary

getClassPathFromManifest	back to summary
pack-priv static ImmutableSet<File> getClassPathFromManifest(File jarFile, 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. Annotations @VisibleForTesting

pack-priv static ImmutableSet<File> getClassPathFromManifest(File jarFile, 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.

Annotations

@VisibleForTesting

getResources	back to summary
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.

getTopLevelClasses	back to summary
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 `ClassInfo#isTopLevel`).

getTopLevelClasses	back to summary
public ImmutableSet<ClassPath.ClassInfo> getTopLevelClasses(String packageName) Returns all top level classes whose package name is `packageName`.

getTopLevelClassesRecursive	back to summary
public ImmutableSet<ClassPath.ClassInfo> getTopLevelClassesRecursive(String packageName) Returns all top level classes whose package name is `packageName` or starts with `packageName` followed by a '.'.

locationsFrom	back to summary
pack-priv static ImmutableSet<ClassPath.LocationInfo> locationsFrom(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.

parseJavaClassPath back to summary

parseJavaClassPath	back to summary
pack-priv static ImmutableList<URL> parseJavaClassPath() Returns the URLs in the class path specified by the `java.class.path` system property. Annotations @VisibleForTesting

pack-priv static ImmutableList<URL> parseJavaClassPath()

Returns the URLs in the class path specified by the java.class.path system property.

Annotations

@VisibleForTesting

toFile	back to summary
pack-priv static File toFile(URL url) Annotations @VisibleForTesting

com.google.common.reflect back to summary

public final Class ClassPath.ClassInfo

Class Inheritance

extends ResourceInfo

java.lang.Object
com.google.common.reflect.ClassPath.ResourceInfo
com.google.common.reflect.ClassPath.ClassInfo

Represents a class that can be loaded through load.

Since: 14.0

Field Summary

Modifier and Type	Field and Description
private final String	className

Inherited from com.google.common.reflect.ClassPath.ResourceInfo:: loader

Constructor Summary

Access	Constructor and Description
pack-priv	ClassInfo(File file, String resourceName, ClassLoader loader)

Method Summary

Modifier and Type	Method and Description
public String	getName() Returns the fully qualified name of the class.
public String	getPackageName() Returns the package name of the class, without attempting to load the class.
public String	getSimpleName() Returns the simple name of the underlying class as given in the source code.
public boolean	isTopLevel() Returns true if the class name "looks to be" top level (not nested), that is, it includes no '$' in the name.
public Class<?>	load() Loads (but doesn't link or initialize) the class.
public String	toString() Overrides com.google.common.reflect.ClassPath.ResourceInfo.toString. Returns a string representation of the object.

Inherited from com.google.common.reflect.ClassPath.ResourceInfo:: asByteSource asCharSource equals getFile getResourceName hashCode of url

Field Detail

className	back to summary
private final String className

Constructor Detail

ClassInfo	back to summary
pack-priv ClassInfo(File file, String resourceName, ClassLoader loader)

Method Detail

getName back to summary

getName	back to summary
public String getName() Returns the fully qualified name of the class. Behaves identically to `Class#getName()` but does not require the class to be loaded.

public String getName()

Returns the fully qualified name of the class.

Behaves identically to Class#getName() but does not require the class to be loaded.

getPackageName back to summary

getPackageName	back to summary
public String getPackageName() Returns the package name of the class, without attempting to load the class. Behaves similarly to `class.getPackage().getName()` but does not require the class (or package) to be loaded. But note that this method may behave differently for a class in the default package: For such classes, this method always returns an empty string. But under some version of Java, `class.getPackage().getName()` produces a `NullPointerException` because `class.getPackage()` returns `null`.

public String getPackageName()

Returns the package name of the class, without attempting to load the class.

Behaves similarly to class.getPackage().getName() but does not require the class (or package) to be loaded.

But note that this method may behave differently for a class in the default package: For such classes, this method always returns an empty string. But under some version of Java, class.getPackage().getName() produces a NullPointerException because class.getPackage() returns null.

getSimpleName back to summary

getSimpleName	back to summary
public String getSimpleName() Returns the simple name of the underlying class as given in the source code. Behaves similarly to `Class#getSimpleName()` but does not require the class to be loaded. But note that this class uses heuristics to identify the simple name. See a related discussion in issue 3349.

public String getSimpleName()

Returns the simple name of the underlying class as given in the source code.

Behaves similarly to Class#getSimpleName() but does not require the class to be loaded.

But note that this class uses heuristics to identify the simple name. See a related discussion in issue 3349.

isTopLevel back to summary

isTopLevel	back to summary
public boolean isTopLevel() Returns true if the class name "looks to be" top level (not nested), that is, it includes no '$' in the name. This method may return false for a top-level class that's intentionally named with the '$' character. If this is a concern, you could use `load` and then check on the loaded `Class` object instead. Since 30.1

public boolean isTopLevel()

Returns true if the class name "looks to be" top level (not nested), that is, it includes no '$' in the name. This method may return false for a top-level class that's intentionally named with the '$' character. If this is a concern, you could use load and then check on the loaded Class object instead.

Since: 30.1

load back to summary

load	back to summary
public Class<?> load() Loads (but doesn't link or initialize) the class. Exceptions LinkageError: when there were errors in loading classes that this class depends on. For example, `NoClassDefFoundError`.

public Class<?> load()

Loads (but doesn't link or initialize) the class.

Exceptions

LinkageError:: when there were errors in loading classes that this class depends on. For example, NoClassDefFoundError.

toString	back to summary
public String toString() Overrides com.google.common.reflect.ClassPath.ResourceInfo.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides com.google.common.reflect.ClassPath.ResourceInfo.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

com.google.common.reflect back to summary

pack-priv final Class ClassPath.LocationInfo

Class Inheritance

extends Object

java.lang.Object
com.google.common.reflect.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.

Field Summary

Modifier and Type	Field and Description
private final ClassLoader	classloader
pack-priv final File	home

Constructor Summary

Access	Constructor and Description
pack-priv	LocationInfo(File home, ClassLoader classloader)

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public final File	file() Returns the file this location is from.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
private void	scan(File file, Set<File> scannedUris, ImmutableSet.Builder<ClassPath.ResourceInfo> builder)
private void	scanDirectory(File directory, ImmutableSet.Builder<ClassPath.ResourceInfo> builder)
private void	scanDirectory(File the root of the directory to scan directory, String resource path prefix inside `classloader` for any files found under `directory` packagePrefix, Set<File> canonical files already visited in the current directory tree path, for cycle elimination currentPath, ImmutableSet.Builder<ClassPath.ResourceInfo> builder) Recursively scan the given directory, adding resources for each file encountered.
private void	scanJar(File file, Set<File> scannedUris, ImmutableSet.Builder<ClassPath.ResourceInfo> builder)
private void	scanJarFile(JarFile file, ImmutableSet.Builder<ClassPath.ResourceInfo> builder)
public ImmutableSet<ClassPath.ResourceInfo>	scanResources() Scans this location and returns all scanned resources.
public ImmutableSet<ClassPath.ResourceInfo>	scanResources(Set<File> scannedFiles) Scans this location and returns all scanned resources.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

Field Detail

classloader	back to summary
private final ClassLoader classloader

home	back to summary
pack-priv final File home

Constructor Detail

LocationInfo	back to summary
pack-priv LocationInfo(File home, ClassLoader classloader)

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object obj) 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. Parameters obj:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object obj)

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.

Parameters

obj:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

file	back to summary
public final File file() Returns the file this location is from.

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for the 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. Returns:int a hash code value for this object. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the 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.

Returns:int

a hash code value for this object.

Annotations

@Override

scan	back to summary
private void scan(File file, Set<File> scannedUris, ImmutableSet.Builder<ClassPath.ResourceInfo> builder) throws IOException

scanDirectory	back to summary
private void scanDirectory(File directory, ImmutableSet.Builder<ClassPath.ResourceInfo> builder) throws IOException

scanDirectory back to summary

scanDirectory	back to summary
private void scanDirectory(File directory, String packagePrefix, Set<File> currentPath, ImmutableSet.Builder<ClassPath.ResourceInfo> builder) throws IOException Recursively scan the given directory, adding resources for each file encountered. Symlinks which have already been traversed in the current tree path will be skipped to eliminate cycles; otherwise symlinks are traversed. Parameters directory:File the root of the directory to scan packagePrefix:String resource path prefix inside `classloader` for any files found under `directory` currentPath:Set<File> canonical files already visited in the current directory tree path, for cycle elimination

private void scanDirectory(File directory, String packagePrefix, Set<File> currentPath, ImmutableSet.Builder<ClassPath.ResourceInfo> builder) throws IOException

Recursively scan the given directory, adding resources for each file encountered. Symlinks which have already been traversed in the current tree path will be skipped to eliminate cycles; otherwise symlinks are traversed.

Parameters

directory:File: the root of the directory to scan
packagePrefix:String: resource path prefix inside classloader for any files found under directory
currentPath:Set<File>: canonical files already visited in the current directory tree path, for cycle elimination

scanJar	back to summary
private void scanJar(File file, Set<File> scannedUris, ImmutableSet.Builder<ClassPath.ResourceInfo> builder) throws IOException

scanJarFile	back to summary
private void scanJarFile(JarFile file, ImmutableSet.Builder<ClassPath.ResourceInfo> builder)

scanResources	back to summary
public ImmutableSet<ClassPath.ResourceInfo> scanResources() throws IOException Scans this location and returns all scanned resources.

scanResources back to summary

scanResources	back to summary
public ImmutableSet<ClassPath.ResourceInfo> scanResources(Set<File> scannedFiles) throws IOException Scans this location and returns all scanned resources. This file and jar files from "Class-Path" entry in the scanned manifest files will be added to `scannedFiles`. A file will be scanned at most once even if specified multiple times by one or multiple jar files' "Class-Path" manifest entries. Particularly, if a jar file from the "Class-Path" manifest entry is already in `scannedFiles`, either because it was scanned earlier, or it was intentionally added to the set by the caller, it will not be scanned again. Note that when you call `location.scanResources(scannedFiles)`, the location will always be scanned even if `scannedFiles` already contains it.

public ImmutableSet<ClassPath.ResourceInfo> scanResources(Set<File> scannedFiles) throws IOException

Scans this location and returns all scanned resources.

This file and jar files from "Class-Path" entry in the scanned manifest files will be added to scannedFiles.

A file will be scanned at most once even if specified multiple times by one or multiple jar files' "Class-Path" manifest entries. Particularly, if a jar file from the "Class-Path" manifest entry is already in scannedFiles, either because it was scanned earlier, or it was intentionally added to the set by the caller, it will not be scanned again.

Note that when you call location.scanResources(scannedFiles), the location will always be scanned even if scannedFiles already contains it.

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

com.google.common.reflect back to summary

public Class ClassPath.ResourceInfo

Class Inheritance

extends Object

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

Known Direct Subclasses

com.google.common.reflect.ClassPath.ClassInfo

Represents a class path resource that can be either a class file or any other resource file loadable from the class path.

Since: 14.0

Field Summary

Modifier and Type	Field and Description
private final File	file
pack-priv final ClassLoader	loader
private final String	resourceName

Constructor Summary

Access	Constructor and Description
pack-priv	ResourceInfo(File file, String resourceName, ClassLoader loader)

Method Summary

Modifier and Type	Method and Description
public final ByteSource	asByteSource() Returns a `ByteSource` view of the resource from which its bytes can be read.
public final CharSource	asCharSource(Charset charset) Returns a `CharSource` view of the resource from which its bytes can be read as characters decoded with the given `charset`.
public boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
pack-priv final File	getFile() Returns the file that includes this resource.
public final String	getResourceName() Returns the fully qualified name of the resource.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
pack-priv static ClassPath.ResourceInfo	of(File file, String resourceName, ClassLoader loader)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public final URL	url() Returns the url identifying the resource.

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

Field Detail

file	back to summary
private final File file

loader	back to summary
pack-priv final ClassLoader loader

resourceName	back to summary
private final String resourceName

Constructor Detail

ResourceInfo	back to summary
pack-priv ResourceInfo(File file, String resourceName, ClassLoader loader)

Method Detail

asByteSource back to summary

public final ByteSource asByteSource()

Returns a ByteSource view of the resource from which its bytes can be read.

Exceptions

NoSuchElementException:: if the resource cannot be loaded through the class loader, despite physically existing in the class path.

Since

20.0

asCharSource back to summary

public final CharSource asCharSource(Charset charset)

Returns a CharSource view of the resource from which its bytes can be read as characters decoded with the given charset.

Exceptions

NoSuchElementException:: if the resource cannot be loaded through the class loader, despite physically existing in the class path.

Since

20.0

equals back to summary

public boolean equals(Object obj)

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.

Parameters

obj:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getFile	back to summary
pack-priv final File getFile() Returns the file that includes this resource.

getResourceName	back to summary
public final String getResourceName() Returns the fully qualified name of the resource. Such as "com/mycomp/foo/bar.txt".

hashCode back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the 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.

Returns:int

a hash code value for this object.

Annotations

@Override

of	back to summary
pack-priv static ClassPath.ResourceInfo of(File file, String resourceName, ClassLoader loader)

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

url back to summary

public final URL url()

Returns the url identifying the resource.

See ClassLoader#getResource

Exceptions

NoSuchElementException:: if the resource cannot be loaded through the class loader, despite physically existing in the class path.

public final Class ClassPath

Prefer ClassGraph over `ClassPath`

`ClassPath` and symlinks

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class ClassPath.ClassInfo

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Class ClassPath.LocationInfo

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class ClassPath.ResourceInfo

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class ClassPath

Prefer ClassGraph over ClassPath

ClassPath and symlinks

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class ClassPath.ClassInfo

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Class ClassPath.LocationInfo

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class ClassPath.ResourceInfo

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Prefer ClassGraph over `ClassPath`

`ClassPath` and symlinks