net.openhft.chronicle.wire

Class AbstractClassGenerator<M extends AbstractClassGenerator.MetaData<M>>

java.lang.Object

net.openhft.chronicle.wire.AbstractClassGenerator<M>

Type Parameters:

M - Represents the meta-data associated with the class being generated.

Direct Known Subclasses:

GenerateMethodBridge, GenerateMethodDelegate, GenerateMethodWriter2

public abstract class AbstractClassGenerator<M extends AbstractClassGenerator.MetaData<M>>
extends Object

Abstract generator for classes at runtime based on meta-data. This class leverages the CachedCompiler to dynamically compile and load classes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractClassGenerator.MetaData<M extends AbstractClassGenerator.MetaData<M>> Represents the metadata configuration required for the class generator.

Field Summary

Fields

Modifier and Type	Field and Description
static net.openhft.compiler.CachedCompiler	CACHED_COMPILER
protected SortedSet<String>	importSet
protected SourceCodeFormatter	sourceCode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractClassGenerator(M metaData) Constructor for initializing the generator with its associated meta-data.

Method Summary

Modifier and Type	Method and Description
<T> Class<T>	acquireClass(ClassLoader classLoader) Attempts to acquire the generated class.
protected @NotNull String	className() Generates a class name based on the metadata and possibly a hash value.
protected Class<?>	extendsClass() Specifies which class the generated class should extend.
protected String	fieldCase(Class<?> clazz) Generates a field name based on the given class.
protected void	generateConstructors(SourceCodeFormatter mainCode) Generates constructors for the class.
protected void	generateEnd(SourceCodeFormatter mainCode) Stub method for subclasses to implement end code generation, if necessary.
protected void	generateFields(SourceCodeFormatter mainCode) Generates fields for the class.
protected String	generateGenericType() Generates a generic type for the class, if required.
protected void	generateMainCode(SourceCodeFormatter mainCode) Generates the main code for the class, including fields, constructors, methods, and more.
protected void	generateMethod(Method method, SourceCodeFormatter mainCode) Generates the implementation for a specific method.
protected abstract void	generateMethod(Method method, StringBuilder params, List<String> paramList, SourceCodeFormatter mainCode) Abstract method for subclasses to implement the body of the generated method.
int	maxCode() Retrieves the maxCode value which seems to determine the maximum number of characters or an internal limit for generated code.
AbstractClassGenerator<M>	maxCode(int maxCode) Sets the maxCode value.
M	metaData() Retrieves the meta-data associated with this generator.
protected @NotNull Set<Method>	methodsToOverride() Determines the set of methods that should be overridden based on the provided metadata.
String	nameForClass(Class<?> clazz) Generates a name for the given class.
protected SourceCodeFormatter	withLineNumber(SourceCodeFormatter mainCode) Appends the line number and stack trace for better traceability in the generated code.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CACHED_COMPILER

public static final net.openhft.compiler.CachedCompiler CACHED_COMPILER

sourceCode

protected final SourceCodeFormatter sourceCode

importSet

protected SortedSet<String> importSet

Constructor Detail

AbstractClassGenerator

protected AbstractClassGenerator(M metaData)

Constructor for initializing the generator with its associated meta-data.

Parameters:

metaData - Meta-data related to the class to be generated.

Method Detail

metaData

public M metaData()

Retrieves the meta-data associated with this generator.

Returns:

Meta-data related to the class being generated.

acquireClass

public <T> Class<T> acquireClass(ClassLoader classLoader)

Attempts to acquire the generated class. If the class is not yet generated or loaded, it will trigger the generation and loading of the class.

Type Parameters:

T - The type of the generated class.

Parameters:

classLoader - The class loader to be used for loading the generated class.

Returns:

The generated and loaded class.

generateGenericType

protected String generateGenericType()

Generates a generic type for the class, if required.

Returns:

The generic type as a String, or null if there's none.

extendsClass

protected Class<?> extendsClass()

Specifies which class the generated class should extend. By default, it extends the Object class.

Returns:

The superclass of the generated class.

nameForClass

public String nameForClass(Class<?> clazz)

Generates a name for the given class. This method also handles array types and inner classes, ensuring that names are formatted correctly.

Parameters:

clazz - The class whose name should be generated.

Returns:

A formatted name for the class.

maxCode

public int maxCode()

Retrieves the maxCode value which seems to determine the maximum number of characters or an internal limit for generated code.

Returns:

The maxCode value.

maxCode

public AbstractClassGenerator<M> maxCode(int maxCode)

Sets the maxCode value.

Parameters:

maxCode - The desired maxCode value.

Returns:

The current instance of the class generator for chaining calls.

className

@NotNull
protected @NotNull String className()

Generates a class name based on the metadata and possibly a hash value. This ensures a unique name for each class based on its characteristics.

Returns:

The generated class name.

generateMainCode

protected void generateMainCode(SourceCodeFormatter mainCode)

Generates the main code for the class, including fields, constructors, methods, and more.

Parameters:

mainCode - The code formatter where the generated code is appended.

fieldCase

protected String fieldCase(Class<?> clazz)

Generates a field name based on the given class. If it's a primitive type, special naming is used.

Parameters:

clazz - The class for which the field name is being generated.

Returns:

The generated field name.

generateFields

protected void generateFields(SourceCodeFormatter mainCode)

Generates fields for the class. This method is empty in the base class and can be overridden by subclasses to provide specific implementations.

Parameters:

mainCode - The code formatter where the generated code is appended.

generateConstructors

protected void generateConstructors(SourceCodeFormatter mainCode)

Generates constructors for the class. This method is empty in the base class and can be overridden by subclasses to provide specific implementations.

Parameters:

mainCode - The code formatter where the generated code is appended.

withLineNumber

protected SourceCodeFormatter withLineNumber(SourceCodeFormatter mainCode)

Appends the line number and stack trace for better traceability in the generated code.

Parameters:

mainCode - The code formatter where the line information is appended.

Returns:

The updated code formatter.

generateMethod

protected void generateMethod(Method method,
                              SourceCodeFormatter mainCode)

Generates the implementation for a specific method.

Parameters:

method - The method whose code is being generated.

mainCode - The code formatter where the generated code is appended.

generateEnd

protected void generateEnd(SourceCodeFormatter mainCode)

Stub method for subclasses to implement end code generation, if necessary.

Parameters:

mainCode - The code formatter where the generated code is appended.

generateMethod

protected abstract void generateMethod(Method method,
                                       StringBuilder params,
                                       List<String> paramList,
                                       SourceCodeFormatter mainCode)

Abstract method for subclasses to implement the body of the generated method.

Parameters:

method - The method whose body is being generated.

params - The parameters of the method in a StringBuilder.

paramList - The list of parameter names.

mainCode - The code formatter where the generated code is appended.

methodsToOverride

@NotNull
protected @NotNull Set<Method> methodsToOverride()

Determines the set of methods that should be overridden based on the provided metadata.

The method retrieves abstract methods from the interfaces specified in the metadata and the superclass. Any concrete method present in the superclass or interfaces is considered to have already been overridden, so these methods are excluded from the result.

Returns:

A set of methods that need to be overridden.