Type (ValjoGen-AnnotationProcessor 2.0.0 API)

java.lang.Object
- com.fortyoneconcepts.valjogen.model.ModelBase
- - com.fortyoneconcepts.valjogen.model.Type

All Implemented Interfaces:

Model

Direct Known Subclasses:

ArrayType, ObjectType, PrimitiveType
```
public abstract class Type
extends ModelBase
```
Information about a type that a model use or refer to. Actual types are divided into 3 concrete subclasses depending on the category of the type. I.e. if the type is a primitive, an array or an object.

Field Summary

Fields
Modifier and Type Field and Description

protected BasicClazz clazzUsingType

protected String qualifiedProtoTypicalTypeName
- Fields inherited from class com.fortyoneconcepts.valjogen.model.ModelBase
  MAX_RECURSIVE_LEVEL, NO_DETAILS_LEVEL

Fields
Modifier and Type	Field and Description
`protected BasicClazz`	`clazzUsingType`
`protected String`	`qualifiedProtoTypicalTypeName`

Constructor Summary

Constructors
Modifier Constructor and Description

protected Type(BasicClazz optClazzUsingType, String qualifiedProtoTypicalTypeName)

Constructors
Modifier	Constructor and Description
`protected`	`Type(BasicClazz optClazzUsingType, String qualifiedProtoTypicalTypeName)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canBeMoreDetailed()`
`abstract Type`	`copy(BasicClazz optClazzUsingType)`
`boolean`	`equals(Object obj)`
`BasicClazz`	`getClazz()` Get the (basic) class that this model is used in.
`Configuration`	`getConfiguration()` The configuration object for this model.
`DetailLevel`	`getDetailLevel()`
`String`	`getName()` Returns a simple type name without package unless nedded and without any generic parts.
`String`	`getPackageName()` Returns type package name of the type.
`String`	`getPrototypicalName()` Returns a simple type name without package unless nedded.
`String`	`getPrototypicalQualifiedName()` Returns a full type name with package in front.
`String`	`getQualifiedName()` Returns a type name with package but without any generic parts.
`private String`	`getReflectionOverloadName(Method m, boolean includeMethodName)`
`private Stream<Class<?>>`	`getReflectionSuperTypesWithAscendants(Class<?> clazz)`
`String`	`getSimpleName()` Returns a simple type name without package and without any generic parts.
`abstract TypeCategory`	`getTypeCategory()` Returns this overall category (kind) of type this type is.
`String`	`getWrapperName()` Return the name of the type when represented as an object.
`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.
`boolean`	`isArray()`
`boolean`	`isCollection()`
`boolean`	`isExactQualifiedType(String qualifiedClassOrInterfaceName)` Returns if type exactly matche specified qualified class/interface.
`boolean`	`isExactType(Class<?> _class)` Returns if type exactly matches specified class/interfac
`boolean`	`isExactType(String classOrInterfaceName)` Returns if type exactly matches specified class/interface.
`abstract boolean`	`isInImportScope()` Checks if the type is in scope of the class being generated taking imports and default packages etc.
`boolean`	`isMultiDimensionalArray()`
`boolean`	`isObject()`
`boolean`	`isOfQualifiedType(String qualifiedClassOrInterfaceName)` Returns if type is equal to or implements/inherites from specified qualified class/interface.
`boolean`	`isOfType(Class<?> _class)` Returns if type is equal to or implements/inherites from specified qualified class/interface.
`boolean`	`isOfType(String classOrInterfaceName)` Returns if type is equal to or implements/inherites from specified class/interface.
`boolean`	`isPrimitive()`
`boolean`	`isPrimitiveBoolean()`
`boolean`	`isPrimitiveByte()`
`boolean`	`isPrimitiveChar()`
`boolean`	`isPrimitiveDouble()`
`boolean`	`isPrimitiveFloat()`
`boolean`	`isPrimitiveInt()`
`boolean`	`isPrimitiveLong()`
`boolean`	`isPrimitiveShort()`
`boolean`	`isRootObject()` Checks if the type is java.lang.Object
`boolean`	`isThisSuperType()` Returns if the type is the base class for the generated type (Clazz)
`boolean`	`isThisType()` Returns if the type is a generated type (Clazz)
`boolean`	`isVoid()`
`private Class<?>`	`tryGetReflectionClass()` Only supported for existing classes on classpath.

Methods inherited from class com.fortyoneconcepts.valjogen.model.ModelBase
print, 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.Model
getGeneratedClazz, getVariablesPrefix, isInDefaultPackage

- Field Detail
  - clazzUsingType
```
protected BasicClazz clazzUsingType
```
  - qualifiedProtoTypicalTypeName
```
protected final String qualifiedProtoTypicalTypeName
```
- Constructor Detail
  - Type
```
protected Type(BasicClazz optClazzUsingType,
               String qualifiedProtoTypicalTypeName)
```
- Method Detail
  - copy
```
public abstract Type copy(BasicClazz optClazzUsingType)
```
  - getConfiguration
```
public Configuration getConfiguration()
```
    Description copied from interface: Model
    
    The configuration object for this model.
    
    Returns:
    
    The configuration object used for codegeneration with this model.
  - 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.
    
    Returns:
    
    The class that this model is a part of.
  - getPackageName
```
public String getPackageName()
```
    Returns type package name of the type.
    
    Returns:
    
    The package name of the type.
  - getQualifiedName
```
public String getQualifiedName()
```
    Returns a type name with package but without any generic parts. I.e. no <T> suffix.
    
    Returns:
    
    The qualified type name
  - getPrototypicalQualifiedName
```
public String getPrototypicalQualifiedName()
```
    Returns a full type name with package in front. For generic types this is prototypical. I.e. ClassName<T>
    
    Returns:
    
    The fully qualifid prototypical type name.
  - isInImportScope
```
public abstract boolean isInImportScope()
```
    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).
    
    Returns:
    
    True if type is in scope of the generated class and its imported classes/pacakges.
  - getName
```
public String getName()
```
    Returns a simple type name without package unless nedded and without any generic parts. I.e. no <T> suffix.
    
    Returns:
    
    The simple type name
  - getSimpleName
```
public String getSimpleName()
```
    Returns a simple type name without package and without any generic parts. I.e. no <T> suffix.
    
    Returns:
    
    The simple type name
  - getPrototypicalName
```
public String getPrototypicalName()
```
    Returns a simple type name without package unless nedded. For generic types this is prototypical. I.e. ClassName<T>
    
    Returns:
    
    The prototypical type name without any package.
  - getWrapperName
```
public String getWrapperName()
```
    Return the name of the type when represented as an object. Only yields a different name for primitives.
    
    Returns:
    
    The wrapped type name or just type name if no wrapper exist.
  - isRootObject
```
public boolean isRootObject()
```
    Checks if the type is java.lang.Object
    
    Returns:
    
    True if the type represents java.lang.Object
  - isPrimitive
```
public boolean isPrimitive()
```
  - isVoid
```
public boolean isVoid()
```
  - isPrimitiveByte
```
public boolean isPrimitiveByte()
```
  - isPrimitiveBoolean
```
public boolean isPrimitiveBoolean()
```
  - isPrimitiveChar
```
public boolean isPrimitiveChar()
```
  - isPrimitiveShort
```
public boolean isPrimitiveShort()
```
  - isPrimitiveInt
```
public boolean isPrimitiveInt()
```
  - isPrimitiveLong
```
public boolean isPrimitiveLong()
```
  - isPrimitiveFloat
```
public boolean isPrimitiveFloat()
```
  - isPrimitiveDouble
```
public boolean isPrimitiveDouble()
```
  - isArray
```
public boolean isArray()
```
  - isObject
```
public boolean isObject()
```
  - isMultiDimensionalArray
```
public boolean isMultiDimensionalArray()
```
  - getDetailLevel
```
public DetailLevel getDetailLevel()
```
  - canBeMoreDetailed
```
public boolean canBeMoreDetailed()
```
  - isCollection
```
public boolean isCollection()
```
  - isThisType
```
public boolean isThisType()
```
    Returns if the type is a generated type (Clazz)
    
    Returns:
    
    True if this type is the one being generated.
  - isThisSuperType
```
public boolean isThisSuperType()
```
    Returns if the type is the base class for the generated type (Clazz)
    
    Returns:
    
    True if this type is the base class for the class being generated.
  - getTypeCategory
```
public abstract TypeCategory getTypeCategory()
```
    Returns this overall category (kind) of type this type is.
    
    Returns:
    
    The type category.
  - isExactType
```
public final boolean isExactType(String classOrInterfaceName)
```
    Returns if type exactly matches specified class/interface. Unqualified names are checked against java.lang or java.util packages. If not a match the unqualified name is assumed to belong to the same package as the generated class. Nb. STCustomModelAdaptor recognize this method under the magic name exactType_xxx.
    
    Parameters:
    
    classOrInterfaceName - The name (qualified or unqualified) of the class/interface.
    
    Returns:
    
    True if type is equal to specified class/interface
  - isExactType
```
public final boolean isExactType(Class<?> _class)
```
    Returns if type exactly matches specified class/interfac
    
    Parameters:
    
    _class - The class/interface.
    
    Returns:
    
    True if type is equal to specified class/interface
  - isExactQualifiedType
```
public final boolean isExactQualifiedType(String qualifiedClassOrInterfaceName)
```
    Returns if type exactly matche specified qualified class/interface. Called by isExactType with the qualified name (possibly expanded).
    
    Parameters:
    
    qualifiedClassOrInterfaceName - The qualified name of the class/interface.
    
    Returns:
    
    True if type is equal from specified class/interface
  - isOfType
```
public final boolean isOfType(String classOrInterfaceName)
```
    Returns if type is equal to or implements/inherites from specified class/interface. Unqualified names are checked against java.lang or java.util packages. If not a match the unqualified name is assumed to belong to the same package as the generated class. Nb. STCustomModelAdaptor recoginze this method under the magic name ofType_xxx.
    
    Parameters:
    
    classOrInterfaceName - The name (qualified or unqualified) of the class/interface.
    
    Returns:
    
    True if type is equal to or implements/inherites from specified class/interface
  - isOfType
```
public final boolean isOfType(Class<?> _class)
```
    Returns if type is equal to or implements/inherites from specified qualified class/interface.
    
    Parameters:
    
    _class - The qualified class/interface.
    
    Returns:
    
    True if type is equal to or implements/inherites from specified class/interface
  - isOfQualifiedType
```
public boolean isOfQualifiedType(String qualifiedClassOrInterfaceName)
```
    Returns if type is equal to or implements/inherites from specified qualified class/interface. Called by isOfType with the qualified name (possibly expanded).
    
    Parameters:
    
    qualifiedClassOrInterfaceName - The qualified name of the class/interface.
    
    Returns:
    
    True if type is equal to or implements/inherites from specified class/interface
  - hasStaticMethod
```
public boolean hasStaticMethod(String overloadName)
```
    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.
    
    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)
```
    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.
    
    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)
```
    Returns if type has a static non-private field with the specified name. Nb. STCustomModelAdaptor recoginze this method under the magic name staticMember_xxx.
    
    Parameters:
    
    name - name of field.
    
    Returns:
    
    True if field exist.
  - hasInstanceMember
```
public boolean hasInstanceMember(String name)
```
    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.
    
    Parameters:
    
    name - name of field.
    
    Returns:
    
    True if field exist.
  - getReflectionSuperTypesWithAscendants
```
private final Stream<Class<?>> getReflectionSuperTypesWithAscendants(Class<?> clazz)
```
  - tryGetReflectionClass
```
private final Class<?> tryGetReflectionClass()
```
    Only supported for existing classes on classpath. Other implementations that deal with generated/new classes should not use reflection anyway.
    
    Returns:
    
    The class or null if unsupported.
  - getReflectionOverloadName
```
private final String getReflectionOverloadName(Method m,
                                               boolean includeMethodName)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class Type

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

clazzUsingType

qualifiedProtoTypicalTypeName

Constructor Detail

Type

Method Detail

copy

getConfiguration

getClazz

getPackageName

getQualifiedName

getPrototypicalQualifiedName

isInImportScope

getName

getSimpleName

getPrototypicalName

getWrapperName

isRootObject

isPrimitive

isVoid

isPrimitiveByte

isPrimitiveBoolean

isPrimitiveChar

isPrimitiveShort

isPrimitiveInt

isPrimitiveLong

isPrimitiveFloat

isPrimitiveDouble

isArray

isObject

isMultiDimensionalArray

getDetailLevel

canBeMoreDetailed

isCollection

isThisType

isThisSuperType

getTypeCategory

isExactType

isExactType

isExactQualifiedType

isOfType

isOfType

isOfQualifiedType

hasStaticMethod

hasInstanceMethod

hasStaticMember

hasInstanceMember

getReflectionSuperTypesWithAscendants

tryGetReflectionClass

getReflectionOverloadName

hashCode

equals