net.lenni0451.commons.asm.provider

Interface ClassProvider

All Superinterfaces:

java.lang.AutoCloseable

All Known Implementing Classes:

DelegatingClassProvider, DummyClassProvider, FileSystemClassProvider, InstrumentationCacheClassProvider, InstrumentationLoaderClassProvider, JarFileClassProvider, LazyClassProvider, LoaderClassProvider, MapClassProvider, PathClassProvider

public interface ClassProvider
extends java.lang.AutoCloseable

A provider for class bytecode.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ClassProvider.ClassSupplier

Method Summary

Modifier and Type	Method and Description
default void	close() Close the class provider and free all resources.
default java.util.Map<java.lang.String,ClassProvider.ClassSupplier>	getAllClasses() Get a map of all classes that are available in this provider.
byte[]	getClass(java.lang.String name) Get the bytecode of a class by its name.
default org.objectweb.asm.tree.ClassNode	getClassNode(java.lang.String name) Get the bytecode of a class by its name and convert it to a ClassNode.
default ClassProvider	then(ClassProvider... classProviders) Delegate all missing classes to the given class providers.

Method Detail

getClass

@Nonnull
byte[] getClass(java.lang.String name)
                   throws java.lang.ClassNotFoundException

Get the bytecode of a class by its name.
The name should be in the format of "package/Name".
If the class could not be found, a ClassNotFoundException is thrown.

Parameters:

name - The name of the class

Returns:

The bytecode of the class

Throws:

java.lang.ClassNotFoundException - If the class could not be found

getAllClasses

@Nonnull
default java.util.Map<java.lang.String,ClassProvider.ClassSupplier> getAllClasses()
                                                                                     throws java.lang.UnsupportedOperationException

Get a map of all classes that are available in this provider.
Not every implementation has to support this and can throw an UnsupportedOperationException if it is not supported.
The key format is "package/Name".

Returns:

A map of all classes

Throws:

java.lang.UnsupportedOperationException - If this operation is not supported

close

default void close()
            throws java.lang.Exception

Close the class provider and free all resources.

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.Exception - If an error occurred while closing the class provider

getClassNode

default org.objectweb.asm.tree.ClassNode getClassNode(java.lang.String name)
                                               throws java.lang.ClassNotFoundException

Get the bytecode of a class by its name and convert it to a ClassNode.

Parameters:

name - The name of the class

Returns:

The class node of the class

Throws:

java.lang.ClassNotFoundException - If the class could not be found

See Also:

getClass(String)

then

default ClassProvider then(ClassProvider... classProviders)

Delegate all missing classes to the given class providers.
The class providers are checked in the order they are given.
See DelegatingClassProvider.getAllClasses() for more information on the behavior of this method.
If no class providers are given, the current class provider is returned.

Parameters:

classProviders - The class providers to delegate to

Returns:

A new class provider that delegates to the given provider

See Also:

DelegatingClassProvider