com.fortyoneconcepts.valjogen.model

Interface Model

All Known Subinterfaces:

Definition, TypedModel

All Known Implementing Classes:

Annotation, ArrayType, BasicClazz, Clazz, Constructor, DefinitionBase, DelegateConstructor, DelegateParameter, FactoryMethod, Member, MemberParameter, Method, ModelBase, NoType, ObjectType, Parameter, PrimitiveType, Property, Type

public interface Model

Common interface for all model elements.

Method Summary

Modifier and Type	Method and Description
BasicClazz	getClazz() Get the (basic) class that this model is used in.
Configuration	getConfiguration() The configuration object for this model.
default Clazz	getGeneratedClazz() Get the class that is being generated - the 'root' class of all basic clazzes in the dependency graph.
String	getPackageName() The package that the output belongs to.
default String	getVariablesPrefix() Prefix for (auto-generated) local variables.
default boolean	isInDefaultPackage() True if the output has no package.
void	print(IndentedPrintWriter writer, int level) Helper method for printing out the model nicely without getting into problems with its circular references.

Method Detail

getConfiguration

Configuration getConfiguration()

The configuration object for this model.

Returns:

The configuration object used for codegeneration with this model.

getPackageName

String getPackageName()

The package that the output belongs to.

Returns:

The package name that should be used when generating code for this model.

isInDefaultPackage

default boolean isInDefaultPackage()

True if the output has no package.

Returns:

true if the package that shoulde be used when generating code for this model is a default pacakge.

getClazz

BasicClazz getClazz()

Get the (basic) class that this model is used in. Can be the generated class or another class the generated class depend on.

Returns:

The class that this model is a part of.

getGeneratedClazz

default Clazz getGeneratedClazz()

Get the class that is being generated - the 'root' class of all basic clazzes in the dependency graph.

Returns:

The generated class.

getVariablesPrefix

default String getVariablesPrefix()

Prefix for (auto-generated) local variables.

Returns:

The prefix that should be used for local variables in methods.

print

void print(IndentedPrintWriter writer,
           int level)

Helper method for printing out the model nicely without getting into problems with its circular references.

Parameters:

writer - The writer to print to

level - The curren recursion level. Call with 0 initially.