com.fortyoneconcepts.valjogen.model

Class Clazz

java.lang.Object

com.fortyoneconcepts.valjogen.model.ModelBase

com.fortyoneconcepts.valjogen.model.Type

com.fortyoneconcepts.valjogen.model.ObjectType

com.fortyoneconcepts.valjogen.model.BasicClazz

com.fortyoneconcepts.valjogen.model.Clazz

All Implemented Interfaces:

Definition, Model

public class Clazz
extends BasicClazz
implements Model

Information about the java "class" that need to be generated including additional information about methods that acts as properties. Together with its supertypes it refers to other model elements like members, properties, methods, types etc.

Field Summary

Fields

Modifier and Type	Field and Description
private List<Member>	chosenComparableMembers
private String	fileHeaderText
private List<Type>	importTypes
private String	javaDoc
private EnumSet<Modifier>	modifiers
private List<Property>	properties
private String	qualifiedMaster

Fields inherited from class com.fortyoneconcepts.valjogen.model.BasicClazz

annotations, configuration, declaredModifiers, helperTypes, members, methods, packageName

Fields inherited from class com.fortyoneconcepts.valjogen.model.ObjectType

baseClazzType, genericTypeArguments, initializedType, interfaceTypes, superTypesWithAscendants

Fields inherited from class com.fortyoneconcepts.valjogen.model.Type

clazzUsingType, qualifiedProtoTypicalTypeName

Fields inherited from class com.fortyoneconcepts.valjogen.model.ModelBase

MAX_RECURSIVE_LEVEL, NO_DETAILS_LEVEL

Constructor Summary

Constructors

Constructor and Description
Clazz(Configuration configuration, String qualifiedClassName, String qualifiedMaster, String javaDoc, String fileHeaderText, Function<BasicClazz,HelperTypes> helperFactoryMethod) Constructs a prelimiary Clazz instance from a configuration with only a few values such as name specificed in advanced.

Method Summary

Modifier and Type	Method and Description
Type	copy(BasicClazz clazzUsingType)
boolean	equals(Object obj)
List<Member>	getChosenComparableMembers()
List<Method>	getClaimedImplementationClassMethods()
List<Constructor>	getClaimedImplementationConstructors()
List<Method>	getClaimedImplementationInstanceMethods()
BasicClazz	getClazz() Get the (basic) class that this model is used in.
String	getFileHeaderText()
Clazz	getGeneratedClazz() Get the class that is being generated - the 'root' class of all basic clazzes in the dependency graph.
List<Type>	getImportTypes()
String	getJavaDoc()
String	getMasterName()
EnumSet<Modifier>	getModifiers() Get modifiers as they should be used generated code when defining something.
List<Property>	getPropertyMethods()
int	hashCode()
void	initContent(List<Member> members, List<Property> properties, List<Method> methods, List<Type> importTypes, List<Member> chosenComparableMembers, EnumSet<Modifier> modifiers, List<Annotation> annotations) Nb.
boolean	isAbstract() Checkes if one of the modifiers used for code generation is ABSTRACT.
boolean	isInImportScope() Checks if the type is in scope of the class being generated taking imports and default packages etc.
boolean	isSynchronized()
boolean	isThisType() Returns if the type is a generated type (Clazz)
protected void	printExtraBottom(IndentedPrintWriter writer, int detailLevel)
protected void	printExtraTop(IndentedPrintWriter writer, int detailLevel)

Methods inherited from class com.fortyoneconcepts.valjogen.model.BasicClazz

canBeMoreDetailed, getAnnotations, getConfiguration, getDeclaredModifiers, getDetailLevel, getGenericQualifierText, getHelperTypes, getMembers, getMembersIncludingInherited, getMethods, getPackageName, hasFactoryMethods, hasGenericQualifier, hasInstanceMember, hasInstanceMethod, hasStaticMember, hasStaticMethod, initContent, initialized, isMutable, isThisSuperType, print, tryGetMember, tryGetMemberIncludingInherited, tryGetMethod

Methods inherited from class com.fortyoneconcepts.valjogen.model.ObjectType

getBaseClazzType, getConstructors, getGenericTypeArguments, getInterfaceTypes, getPrototypicalName, getSuperTypesWithAscendants, getTypeCategory, hasAnyMembers, hasArrayMembers, hasCollectionMembers, hasPrimitiveMembers, initType, isObject, isOfQualifiedType, isRootObject

Methods inherited from class com.fortyoneconcepts.valjogen.model.Type

getName, getPrototypicalQualifiedName, getQualifiedName, getSimpleName, getWrapperName, isArray, isCollection, isExactQualifiedType, isExactType, isExactType, isMultiDimensionalArray, isOfType, isOfType, isPrimitive, isPrimitiveBoolean, isPrimitiveByte, isPrimitiveChar, isPrimitiveDouble, isPrimitiveFloat, isPrimitiveInt, isPrimitiveLong, isPrimitiveShort, isVoid

Methods inherited from class com.fortyoneconcepts.valjogen.model.ModelBase

toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.fortyoneconcepts.valjogen.model.Model

getConfiguration, getPackageName, getVariablesPrefix, isInDefaultPackage, print

Methods inherited from interface com.fortyoneconcepts.valjogen.model.Definition

getName, isFinal, isPrivate, isProtected, isPublic, isStatic, isTransient

Field Detail

qualifiedMaster

private final String qualifiedMaster

javaDoc

private final String javaDoc

fileHeaderText

private final String fileHeaderText

properties

private List<Property> properties

importTypes

private List<Type> importTypes

chosenComparableMembers

private List<Member> chosenComparableMembers

modifiers

private EnumSet<Modifier> modifiers

Constructor Detail

Clazz

public Clazz(Configuration configuration,
             String qualifiedClassName,
             String qualifiedMaster,
             String javaDoc,
             String fileHeaderText,
             Function<BasicClazz,HelperTypes> helperFactoryMethod)

Constructs a prelimiary Clazz instance from a configuration with only a few values such as name specificed in advanced. After constructing the instance, the various setters must be used to finish initialization.

Parameters:

configuration - The configuration of how generated code should look.

qualifiedClassName - The full name of the class that should be generated.

qualifiedMaster - The fill name of the item this class was generated from.

javaDoc - JavaDoc if any.

fileHeaderText - Text to output as header for file(s).

helperFactoryMethod - Method that can generate helper types for this class.

Method Detail

copy

public Type copy(BasicClazz clazzUsingType)

Overrides:

copy in class BasicClazz

getClazz

public BasicClazz getClazz()

Description copied from interface: Model

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

Specified by:

getClazz in interface Model

Overrides:

getClazz in class Type

Returns:

The class that this model is a part of.

getGeneratedClazz

public Clazz getGeneratedClazz()

Description copied from interface: Model

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

Specified by:

getGeneratedClazz in interface Model

Returns:

The generated class.

getModifiers

public EnumSet<Modifier> getModifiers()

Description copied from interface: Definition

Get modifiers as they should be used generated code when defining something.

Specified by:

getModifiers in interface Definition

Overrides:

getModifiers in class BasicClazz

Returns:

The set of modifiers to use in generated code when defining something.

isThisType

public boolean isThisType()

Description copied from class: Type

Returns if the type is a generated type (Clazz)

Overrides:

isThisType in class Type

Returns:

True if this type is the one being generated.

getMasterName

public String getMasterName()

getFileHeaderText

public String getFileHeaderText()

isInImportScope

public boolean isInImportScope()

Description copied from class: Type

Checks if the type is in scope of the class being generated taking imports and default packages etc. into account (so it can be used without qualification).

Overrides:

isInImportScope in class ObjectType

Returns:

True if type is in scope of the generated class and its imported classes/pacakges.

initContent

public void initContent(List<Member> members,
                        List<Property> properties,
                        List<Method> methods,
                        List<Type> importTypes,
                        List<Member> chosenComparableMembers,
                        EnumSet<Modifier> modifiers,
                        List<Annotation> annotations)

Nb. Post-constructor for what is inside the class such as methods, members etc. + imports. Calls super class'es initContent internally Both this method and the ancestor class'es ObjectType.initType(com.fortyoneconcepts.valjogen.model.ObjectType, java.util.List<com.fortyoneconcepts.valjogen.model.Type>, java.util.Set<com.fortyoneconcepts.valjogen.model.Type>, java.util.List<com.fortyoneconcepts.valjogen.model.Type>) methods must be called for the class to be fully initialized and ready for use. Must be called only once.

Parameters:

members - Member variables for class.

properties - Property methods for class.

methods - Non-property methods for class.

importTypes - Types to be imported for class.

chosenComparableMembers - Members to be used for compareToOperation

modifiers - The modifiers to use for code generation (NB: This is not declared modifiers for there are none for a class to be generated)

annotations - Annotations to use for code generation.

getJavaDoc

public String getJavaDoc()

isSynchronized

public boolean isSynchronized()

isAbstract

public boolean isAbstract()

Description copied from interface: Definition

Checkes if one of the modifiers used for code generation is ABSTRACT.

Specified by:

isAbstract in interface Definition

Returns:

True if a abstract modifier present.

getPropertyMethods

public List<Property> getPropertyMethods()

getChosenComparableMembers

public List<Member> getChosenComparableMembers()

getClaimedImplementationConstructors

public List<Constructor> getClaimedImplementationConstructors()

getClaimedImplementationInstanceMethods

public List<Method> getClaimedImplementationInstanceMethods()

getClaimedImplementationClassMethods

public List<Method> getClaimedImplementationClassMethods()

getImportTypes

public List<Type> getImportTypes()

hashCode

public int hashCode()

Overrides:

hashCode in class BasicClazz

equals

public boolean equals(Object obj)

Overrides:

equals in class BasicClazz

printExtraTop

protected void printExtraTop(IndentedPrintWriter writer,
                             int detailLevel)

Overrides:

printExtraTop in class ModelBase

printExtraBottom

protected void printExtraBottom(IndentedPrintWriter writer,
                                int detailLevel)

Overrides:

printExtraBottom in class ModelBase