Enum Class ClassLoadingStrategy.Default
- All Implemented Interfaces:
Serializable
,Comparable<ClassLoadingStrategy.Default>
,Constable
,ClassLoadingStrategy<ClassLoader>
,ClassLoadingStrategy.Configurable<ClassLoader>
- Enclosing interface:
ClassLoadingStrategy<T extends ClassLoader>
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected static class
A class loading strategy which applies a class loader injection while applying a givenProtectionDomain
on class injection.protected static class
A class loading strategy which creates a wrapping class loader while applying a givenProtectionDomain
on class loading.Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
Nested classes/interfaces inherited from interface net.bytebuddy.dynamic.loading.ClassLoadingStrategy
ClassLoadingStrategy.Configurable<S extends ClassLoader>, ClassLoadingStrategy.Default, ClassLoadingStrategy.ForBootstrapInjection, ClassLoadingStrategy.ForJnaInjection, ClassLoadingStrategy.ForUnsafeInjection, ClassLoadingStrategy.UsingLookup
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionThe child-first class loading strategy is a modified version of theWRAPPER
where the dynamic types are given priority over any types of a parent class loader with the same name.The strategy is identical toCHILD_FIRST
but exposes the byte arrays that represent a class byClassLoader.getResourceAsStream(String)
.This strategy does not create a new class loader but injects all classes into the givenClassLoader
by reflective access.This strategy creates a newByteArrayClassLoader
with the given class loader as its parent.The strategy is identical toWRAPPER
but exposes the byte arrays that represent a class byClassLoader.getResourceAsStream(String)
. -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final boolean
The default behavior when attempting to load a type that was already loaded.private final ClassLoadingStrategy.Configurable
<ClassLoader> The dispatcher to be used when loading a class.Fields inherited from interface net.bytebuddy.dynamic.loading.ClassLoadingStrategy
BOOTSTRAP_LOADER, NO_PROTECTION_DOMAIN
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
Default
(ClassLoadingStrategy.Configurable<ClassLoader> dispatcher) Creates a new default class loading strategy. -
Method Summary
Modifier and TypeMethodDescriptionDetermines if this class loading strategy should not throw an exception when attempting to load a class that was already loaded.Map
<TypeDescription, Class<?>> load
(ClassLoader classLoader, Map<TypeDescription, byte[]> types) Loads a given collection of classes given their binary representation.opened()
With an opened class loading strategy, it is assured that types can be added to the class loader, either by indirect injection using this strategy or by creating a class loader that explicitly supports injection.static ClassLoadingStrategy.Default
Returns the enum constant of this class with the specified name.static ClassLoadingStrategy.Default[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.with
(ProtectionDomain protectionDomain) Overrides the implicitly set defaultProtectionDomain
with an explicit one.with
(PackageDefinitionStrategy packageDefinitionStrategy) Defines the supplied package definition strategy to be used for defining packages.
-
Enum Constant Details
-
WRAPPER
This strategy creates a newByteArrayClassLoader
with the given class loader as its parent. The byte array class loader is aware of a any dynamically created type and can natively load the given classes. This allows to load classes with cyclic load-time dependencies since the byte array class loader is queried on each encountered unknown class. Due to the encapsulation of the classes that were loaded by a byte array class loader, this strategy will lead to the unloading of these classes once this class loader, its classes or any instances of these classes become unreachable. -
WRAPPER_PERSISTENT
The strategy is identical toWRAPPER
but exposes the byte arrays that represent a class byClassLoader.getResourceAsStream(String)
. For this purpose, all class files are persisted as byte arrays withing the wrapping class loader. -
CHILD_FIRST
The child-first class loading strategy is a modified version of the
WRAPPER
where the dynamic types are given priority over any types of a parent class loader with the same name.Important: This does not replace a type of the same name, but it makes the type invisible by the reach of this class loader.
-
CHILD_FIRST_PERSISTENT
The strategy is identical toCHILD_FIRST
but exposes the byte arrays that represent a class byClassLoader.getResourceAsStream(String)
. For this purpose, all class files are persisted as byte arrays withing the wrapping class loader. -
INJECTION
This strategy does not create a new class loader but injects all classes into the given
ClassLoader
by reflective access. This prevents the loading of classes with cyclic load-time dependencies but avoids the creation of an additional class loader. The advantage of this strategy is that the loaded classes will have package-private access to other classes within their package of the class loader into which they are injected what is not permitted when the wrapper class loader is used. This strategy is implemented using aClassInjector.UsingReflection
. Note that this strategy usually yields a better runtime performance.Important: Class injection requires access to JVM internal methods that are sealed by security managers and the Java Platform module system. Since Java 11, access to these methods is no longer feasible unless those packages are explicitly opened.
Note: This class loader does not define packages for injected classes by default. Therefore, calls to
Class.getPackage()
might returnnull
. Packages are only defined manually by a class loader prior to Java 9.
-
-
Field Details
-
DEFAULT_FORBID_EXISTING
private static final boolean DEFAULT_FORBID_EXISTINGThe default behavior when attempting to load a type that was already loaded.- See Also:
-
dispatcher
The dispatcher to be used when loading a class.
-
-
Constructor Details
-
Default
Creates a new default class loading strategy.- Parameters:
dispatcher
- The dispatcher to be used when loading a class.
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum class has no constant with the specified nameNullPointerException
- if the argument is null
-
load
public Map<TypeDescription,Class<?>> load(@MaybeNull ClassLoader classLoader, Map<TypeDescription, byte[]> types) Loads a given collection of classes given their binary representation.- Specified by:
load
in interfaceClassLoadingStrategy<ClassLoader>
- Parameters:
classLoader
- The class loader to used for loading the classes.types
- Byte array representations of the types to be loaded mapped by their descriptions, where an iteration order defines an order in which they are supposed to be loaded, if relevant.- Returns:
- A collection of the loaded classes which will be initialized in the iteration order of the returned collection.
-
with
Overrides the implicitly set defaultProtectionDomain
with an explicit one.- Specified by:
with
in interfaceClassLoadingStrategy.Configurable<ClassLoader>
- Parameters:
protectionDomain
- The protection domain to apply ornull
if no protection domain is set.- Returns:
- This class loading strategy with an explicitly set
ProtectionDomain
.
-
with
public ClassLoadingStrategy.Configurable<ClassLoader> with(PackageDefinitionStrategy packageDefinitionStrategy) Defines the supplied package definition strategy to be used for defining packages.- Specified by:
with
in interfaceClassLoadingStrategy.Configurable<ClassLoader>
- Parameters:
packageDefinitionStrategy
- The package definer to be used.- Returns:
- A version of this class loading strategy that applies the supplied package definition strategy.
-
allowExistingTypes
Determines if this class loading strategy should not throw an exception when attempting to load a class that was already loaded. In this case, the already loaded class is used instead of the generated class.- Specified by:
allowExistingTypes
in interfaceClassLoadingStrategy.Configurable<ClassLoader>
- Returns:
- A version of this class loading strategy that does not throw an exception when a class is already loaded.
-
opened
With an opened class loading strategy, it is assured that types can be added to the class loader, either by indirect injection using this strategy or by creating a class loader that explicitly supports injection.- Specified by:
opened
in interfaceClassLoadingStrategy.Configurable<ClassLoader>
- Returns:
- A version of this class loading strategy that opens for future injections into a class loader.
-