com.fortyoneconcepts.valjogen.model

Class BasicClazz

java.lang.Object

com.fortyoneconcepts.valjogen.model.ModelBase

com.fortyoneconcepts.valjogen.model.Type

com.fortyoneconcepts.valjogen.model.ObjectType

com.fortyoneconcepts.valjogen.model.BasicClazz

All Implemented Interfaces:

Definition, Model

Direct Known Subclasses:

Clazz

public class BasicClazz
extends ObjectType
implements Definition

Detailed information about a java "class" such as members and methods. Base class for Clazz which is the class type used for generation of code.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Annotation>	annotations
protected Configuration	configuration
protected EnumSet<Modifier>	declaredModifiers
protected HelperTypes	helperTypes
private boolean	initializedContent
protected List<Member>	members
protected List<Method>	methods
protected String	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

Modifier	Constructor and Description
	BasicClazz(BasicClazz optClazzUsingType, Configuration configuration, String qualifiedProtoTypicalTypeName, Function<BasicClazz,HelperTypes> helperFactoryMethod)
private	BasicClazz(BasicClazz optClazzUsingType, Configuration configuration, String qualifiedProtoTypicalTypeName, Function<BasicClazz,HelperTypes> helperFactoryMethod, List<Member> members, List<Method> methods, EnumSet<Modifier> declaredModifiers, List<Annotation> annotations)

Method Summary

Modifier and Type	Method and Description
boolean	canBeMoreDetailed()
Type	copy(BasicClazz clazzUsingType)
boolean	equals(Object obj)
List<Annotation>	getAnnotations() Get annotations associated with this definition.
Configuration	getConfiguration() The configuration object for this model.
EnumSet<Modifier>	getDeclaredModifiers() Get modifiers as orginally declared in inteface or base class (or none if new method).
DetailLevel	getDetailLevel()
String	getGenericQualifierText()
HelperTypes	getHelperTypes()
List<Member>	getMembers()
List<Member>	getMembersIncludingInherited()
List<Method>	getMethods()
EnumSet<Modifier>	getModifiers() Get modifiers as they should be used generated code when defining something.
String	getPackageName() Returns type package name of the type.
boolean	hasFactoryMethods()
boolean	hasGenericQualifier()
int	hashCode()
boolean	hasInstanceMember(String name) Returns if type has a non-private instance member field with the specified name.
boolean	hasInstanceMethod(String overloadName) Returns if type has a non-private instance method with the specified overload name.
boolean	hasStaticMember(String name) Returns if type has a static non-private field with the specified name.
boolean	hasStaticMethod(String overloadName) Returns if type has a static non-private method with the specified overload name.
void	initContent(List<Member> members, List<Method> methods, EnumSet<Modifier> declaredModifiers, List<Annotation> annotations) Nb.
boolean	initialized()
boolean	isMutable()
boolean	isThisSuperType() Returns if the type is the base class for the generated type (Clazz)
void	print(IndentedPrintWriter writer, int detailLevel) Helper method for printing out the model nicely without getting into problems with its circular references.
Member	tryGetMember(String name)
Member	tryGetMemberIncludingInherited(String name)
Method	tryGetMethod(String name)

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

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

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

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

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

printExtraBottom, printExtraTop, toString

Methods inherited from class java.lang.Object

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

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

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

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

getClazz, getGeneratedClazz, getVariablesPrefix, isInDefaultPackage

Field Detail

configuration

protected final Configuration configuration

packageName

protected final String packageName

helperTypes

protected final HelperTypes helperTypes

members

protected List<Member> members

methods

protected List<Method> methods

declaredModifiers

protected EnumSet<Modifier> declaredModifiers

annotations

protected List<Annotation> annotations

initializedContent

private boolean initializedContent

Constructor Detail

BasicClazz

public BasicClazz(BasicClazz optClazzUsingType,
                  Configuration configuration,
                  String qualifiedProtoTypicalTypeName,
                  Function<BasicClazz,HelperTypes> helperFactoryMethod)

BasicClazz

private BasicClazz(BasicClazz optClazzUsingType,
                   Configuration configuration,
                   String qualifiedProtoTypicalTypeName,
                   Function<BasicClazz,HelperTypes> helperFactoryMethod,
                   List<Member> members,
                   List<Method> methods,
                   EnumSet<Modifier> declaredModifiers,
                   List<Annotation> annotations)

Method Detail

copy

public Type copy(BasicClazz clazzUsingType)

Overrides:

copy in class ObjectType

initialized

public boolean initialized()

Overrides:

initialized in class ObjectType

initContent

public void initContent(List<Member> members,
                        List<Method> methods,
                        EnumSet<Modifier> declaredModifiers,
                        List<Annotation> annotations)

Nb. Post-constructor for what is inside the class such as methods, members etc. + imports. Both this method and the super 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.

methods - Other methods for class.

declaredModifiers - declared clazz modifiers (empty if a new Clazz)

annotations - Annotations for the clazz.

getConfiguration

public Configuration getConfiguration()

Description copied from interface: Model

The configuration object for this model.

Specified by:

getConfiguration in interface Model

Overrides:

getConfiguration in class Type

Returns:

The configuration object used for codegeneration with this model.

getPackageName

public String getPackageName()

Description copied from class: Type

Returns type package name of the type.

Specified by:

getPackageName in interface Model

Overrides:

getPackageName in class Type

Returns:

The package name of the type.

getHelperTypes

public HelperTypes getHelperTypes()

getDeclaredModifiers

public EnumSet<Modifier> getDeclaredModifiers()

Description copied from interface: Definition

Get modifiers as orginally declared in inteface or base class (or none if new method).

Specified by:

getDeclaredModifiers in interface Definition

Returns:

The set of orginal modifiers for reference

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

Returns:

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

getAnnotations

public List<Annotation> getAnnotations()

Description copied from interface: Definition

Get annotations associated with this definition.

Specified by:

getAnnotations in interface Definition

Returns:

The list of anntations to use in generated code when defining something.

getDetailLevel

public DetailLevel getDetailLevel()

Overrides:

getDetailLevel in class Type

isThisSuperType

public boolean isThisSuperType()

Description copied from class: Type

Returns if the type is the base class for the generated type (Clazz)

Overrides:

isThisSuperType in class Type

Returns:

True if this type is the base class for the class being generated.

canBeMoreDetailed

public boolean canBeMoreDetailed()

Overrides:

canBeMoreDetailed in class ObjectType

hasGenericQualifier

public boolean hasGenericQualifier()

getGenericQualifierText

public String getGenericQualifierText()

tryGetMember

public Member tryGetMember(String name)

tryGetMemberIncludingInherited

public Member tryGetMemberIncludingInherited(String name)

tryGetMethod

public Method tryGetMethod(String name)

isMutable

public boolean isMutable()

getMembers

public List<Member> getMembers()

Overrides:

getMembers in class ObjectType

getMethods

public List<Method> getMethods()

Overrides:

getMethods in class ObjectType

getMembersIncludingInherited

public List<Member> getMembersIncludingInherited()

hasFactoryMethods

public boolean hasFactoryMethods()

hasStaticMethod

public boolean hasStaticMethod(String overloadName)

Description copied from class: Type

Returns if type has a static non-private method with the specified overload name. Nb. STCustomModelAdaptor recoginze this method under the magic name staticMethod_xxx. Note that because of type erasure the type of argument may be a plain Object when using reflection for lookup as used in default implementation When this method is overidden erasure is not used so this should not be an issue for overriding subclasses.

Overrides:

hasStaticMethod in class Type

Parameters:

overloadName - overload name of form <methodName> "(" <unqualifed parameter type name> { "," <unqualifed parameter type name> } ")"

Returns:

True if method exist.

hasInstanceMethod

public boolean hasInstanceMethod(String overloadName)

Description copied from class: Type

Returns if type has a non-private instance method with the specified overload name. Note that because of type erasure the type of argument may be a plain Object when using reflection for lookup as used in default implementation When this method is overidden erasure is not used so this should not be an issue for overriding subclasses. Nb. STCustomModelAdaptor recoginze this method under the magic name instanceMethod_xxx.

Overrides:

hasInstanceMethod in class Type

Parameters:

overloadName - overload name of form <methodName> "(" <unqualifed parameter type name> { "," <unqualifed parameter type name> } ")"

Returns:

True if method exist.

hasStaticMember

public boolean hasStaticMember(String name)

Description copied from class: Type

Returns if type has a static non-private field with the specified name. Nb. STCustomModelAdaptor recoginze this method under the magic name staticMember_xxx.

Overrides:

hasStaticMember in class Type

Parameters:

name - name of field.

Returns:

True if field exist.

hasInstanceMember

public boolean hasInstanceMember(String name)

Description copied from class: Type

Returns if type has a non-private instance member field with the specified name. Nb. STCustomModelAdaptor recoginze this method under the magic name instanceMember_xxx.

Overrides:

hasInstanceMember in class Type

Parameters:

name - name of field.

Returns:

True if field exist.

hashCode

public int hashCode()

Overrides:

hashCode in class Type

equals

public boolean equals(Object obj)

Overrides:

equals in class Type

print

public void print(IndentedPrintWriter writer,
                  int detailLevel)

Description copied from interface: Model

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

Specified by:

print in interface Model

Overrides:

print in class ObjectType

Parameters:

writer - The writer to print to

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