net.bytebuddy.dynamic

Interface DynamicType

All Known Subinterfaces:

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

All Known Implementing Classes:

DynamicType.Default, DynamicType.Default.Loaded, DynamicType.Default.Unloaded

public interface DynamicType

A dynamic type that is created at runtime, usually as the result of applying a DynamicType.Builder or as the result of an AuxiliaryType.

Note that the TypeDescriptions will represent their unloaded forms and therefore differ from the loaded types, especially with regards to annotations.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	DynamicType.Builder<T> A builder for defining a dynamic type.
static class	DynamicType.Default A default implementation of a dynamic type.
static interface	DynamicType.Loaded<T> A dynamic type that has been loaded into the running instance of the Java virtual machine.
static interface	DynamicType.Unloaded<T> A dynamic type that has not yet been loaded by a given ClassLoader.

Method Summary

Modifier and Type	Method and Description
byte[]	getBytes() Returns a byte array representing this dynamic type.
TypeDescription	getDescription() Returns a description of this dynamic type.
Map<TypeDescription,byte[]>	getRawAuxiliaryTypes() Returns a map of all auxiliary types that are required for making use of the main type.
Map<TypeDescription,LoadedTypeInitializer>	getTypeInitializers() Returns a map of all loaded type initializers for the main type and all auxiliary types, if any.
boolean	hasAliveTypeInitializers() Checks if a dynamic type requires some form of explicit type initialization, either for itself or for one of its auxiliary types, if any.
Map<TypeDescription,File>	saveIn(File folder) Saves a dynamic type in a given folder using the Java class file format while respecting the naming conventions for saving compiled Java classes.

Method Detail

getDescription

TypeDescription getDescription()

Returns a description of this dynamic type.

Returns:

A description of this dynamic type.

getBytes

byte[] getBytes()

Returns a byte array representing this dynamic type. This byte array might be reused by this dynamic type and must therefore not be altered.

Returns:

A byte array of the type's binary representation.

getRawAuxiliaryTypes

Map<TypeDescription,byte[]> getRawAuxiliaryTypes()

Returns a map of all auxiliary types that are required for making use of the main type.

Returns:

A map of all auxiliary types by their descriptions to their binary representation.

getTypeInitializers

Map<TypeDescription,LoadedTypeInitializer> getTypeInitializers()

Returns a map of all loaded type initializers for the main type and all auxiliary types, if any.

Returns:

A mapping of all types' descriptions to their loaded type initializers.

hasAliveTypeInitializers

boolean hasAliveTypeInitializers()

Checks if a dynamic type requires some form of explicit type initialization, either for itself or for one of its auxiliary types, if any. This is the case when this dynamic type was defined to delegate method calls to a specific instance which is stored in a field of the created type. If this class serialized, it could not be used without its loaded type initializers since the field value represents a specific runtime context.

Returns:

true if this type requires explicit type initialization.

saveIn

Map<TypeDescription,File> saveIn(File folder)
                          throws IOException

Saves a dynamic type in a given folder using the Java class file format while respecting the naming conventions for saving compiled Java classes. All auxiliary types, if any, are saved in the same directory. The resulting folder structure will resemble the structure that is required for Java runtimes, i.e. each folder representing a segment of the package name.

Parameters:

folder - The base target folder for storing this dynamic type and its auxiliary types, if any.

Returns:

A map of type descriptions pointing to files with their stored binary representations within folder.

Throws:

IOException - Thrown if the underlying file operations cause an IOException.