Interface ClassFileLocator

All Superinterfaces:

AutoCloseable, Closeable

All Known Subinterfaces:

DynamicType, DynamicType.Loaded<T>, DynamicType.Unloaded<T>

All Known Implementing Classes:

AgentBuilder.Transformer.ForAdvice.LazyDynamicType, ClassFileLocator.Compound, ClassFileLocator.Filtering, ClassFileLocator.ForClassLoader, ClassFileLocator.ForClassLoader.WeaklyReferenced, ClassFileLocator.ForFolder, ClassFileLocator.ForInstrumentation, ClassFileLocator.ForJarFile, ClassFileLocator.ForModule, ClassFileLocator.ForModule.WeaklyReferenced, ClassFileLocator.ForModuleFile, ClassFileLocator.ForUrl, ClassFileLocator.MultiReleaseAware, ClassFileLocator.NoOp, ClassFileLocator.PackageDiscriminating, ClassFileLocator.Simple, DynamicType.AbstractBase, DynamicType.Default, DynamicType.Default.Loaded, DynamicType.Default.Unloaded, Plugin.Engine.Default.SourceEntryPrependingClassFileLocator

public interface ClassFileLocator
extends Closeable

Locates a class file or its byte array representation when it is given its type description.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ClassFileLocator.Compound	A compound ClassFileLocator that chains several locators.
static class	ClassFileLocator.Filtering	A class file locator that only applies for matched names.
static class	ClassFileLocator.ForClassLoader	A class file locator that queries a class loader for binary representations of class files.
static class	ClassFileLocator.ForFolder	A class file locator that finds files from a standardized Java folder structure with folders donating packages and class files being saved as <classname>.class files within their package folder.
static class	ClassFileLocator.ForInstrumentation	A Java agent that allows the location of class files by emulating a retransformation.
static class	ClassFileLocator.ForJarFile	A class file locator that locates classes within a Java jar file.
static class	ClassFileLocator.ForModule	A class file locator that locates class files by querying a Java module's getResourceAsStream method.
static class	ClassFileLocator.ForModuleFile	A class file locator that locates classes within a Java jmod file.
static class	ClassFileLocator.ForUrl	A class file locator that reads class files from one or several URLs.
static class	ClassFileLocator.MultiReleaseAware	A class file locator that is aware of multi-release JAR file semantics.
static enum	ClassFileLocator.NoOp	A class file locator that cannot locate any class files.
static class	ClassFileLocator.PackageDiscriminating	A class file locator that discriminates by a type's package.
static interface	ClassFileLocator.Resolution	Represents a class file as binary data.
static class	ClassFileLocator.Simple	A simple class file locator that returns class files from a selection of given types.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLASS_FILE_EXTENSION	The file extension for a Java class file.
static final String	META_INF_VERSIONS	The prefix folder for META-INF/versions/ which contains multi-release files.

Method Summary

Modifier and Type	Method	Description
ClassFileLocator.Resolution	locate(String name)	Locates the class file for a given type and returns the binary data of the class file.

Methods inherited from interface Closeable

close

Field Details

CLASS_FILE_EXTENSION

static final String CLASS_FILE_EXTENSION

The file extension for a Java class file.

See Also:

• Constant Field Values

META_INF_VERSIONS

static final String META_INF_VERSIONS

The prefix folder for META-INF/versions/ which contains multi-release files.

See Also:

• Constant Field Values

Method Details

locate

ClassFileLocator.Resolution locate(String name)
                            throws IOException

Locates the class file for a given type and returns the binary data of the class file.

Parameters:

name - The name of the type to locate a class file representation for.

Returns:

Any binary representation of the type which might be illegal.

Throws:

IOException - If reading a class file causes an error.