TypeNode (annotations 0.4.0 API)

java.lang.Object
- org.leandreck.endpoints.processor.model.TypeNode

public abstract class TypeNode
extends Object

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`String`	`getAsFunctionParameter()` Returns the parameterName if set or the fieldName and appends an '?'
`String`	`getAsVariableName()` Returns the parameterName if set or the fieldName and does not append an '?'
`abstract List<TypeNode>`	`getChildren()`
`Set<EnumValue>`	`getEnumValues()`
`abstract String`	`getFieldName()` Declared name of this Type as Methodparameter or Variable.
`abstract Set<TypeNode>`	`getImports()`
`abstract TypeNodeKind`	`getKind()` `TypeNodeKind` of this TypeNode.
`abstract String`	`getParameterName()` Declared name or value in `RequestParam` or `PathVariable` Annotation of this Type.
`abstract String`	`getTemplate()` Classpath to the Freemarker Template which is used to generate this TypeNode.
`abstract String`	`getType()` Returns the template-usable String representing this `TypeNode` with added decorations like '[]' as suffix for collections or bound Generics.
`abstract String`	`getTypeName()` This is the raw name of this TypeNode without any decorations for collections or maps or bound Generics.
`String`	`getTypeNameVariable()`
`abstract List<TypeNode>`	`getTypeParameters()` Typeparameters are bound Generics as in `GenericType<BoundType>`.
`abstract Set<TypeNode>`	`getTypes()`
`String`	`getVariableType()`
`int`	`hashCode()`
`boolean`	`isDeclaredComplexType()`
`boolean`	`isMappedType()` Returns true if this TypeNode is a mapped Type.
`boolean`	`isOptional()` Returns wether this TypeNode is an optional Parameter or not.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getKind
```
public abstract TypeNodeKind getKind()
```
    TypeNodeKind of this TypeNode.
    
    Returns:
    
    TypeNodeKind
  - getFieldName
```
public abstract String getFieldName()
```
    Declared name of this Type as Methodparameter or Variable. For example private String someFieldName; results in "someFieldName" as fieldName or public void execute(String anotherFieldName) {...} in "anotherFieldName".
    
    Returns:
    
    fieldname
  - getParameterName
```
public abstract String getParameterName()
```
    Declared name or value in RequestParam or PathVariable Annotation of this Type.
    
    For example:
    public void delete(@PathVariable(name = "pathVariable") Long id, @RequestParam(name = "queryParam") String queryParameter){...}
    results in "pathVariable" as parameterName for id and "queryParam" for queryParameter.
    
    Returns:
    
    parametername
  - getAsFunctionParameter
```
public String getAsFunctionParameter()
```
    Returns the parameterName if set or the fieldName and appends an '?' if this TypeNode isOptional() == true. Templates can use this to declare Method-Parameters or use getAsVariableName() and declare optional Parameters them self.
    
    Returns:
    
    variable name as function parameter
  - getAsVariableName
```
public String getAsVariableName()
```
    Returns the parameterName if set or the fieldName and does not append an '?' if this TypeNode isOptional() == true. Templates should use this as Variable-Name if used not as Function-Parameter.
    
    Returns:
    
    variable name
  - getTypeName
```
public abstract String getTypeName()
```
    This is the raw name of this TypeNode without any decorations for collections or maps or bound Generics.
    Most of the time you should use getType() in your templates. For example:
    - Map<String, Number> -> 'Map'
    - List<GenericType<Innertype>> -> 'List'
    Returns:
    
    name of this TypeNode.
    
    See Also:
    
    getType()
  - getTypeNameVariable
```
public String getTypeNameVariable()
```
  - getType
```
public abstract String getType()
```
    Returns the template-usable String representing this TypeNode with added decorations like '[]' as suffix for collections or bound Generics.
    For example:
    - Map<String, Number> -> '{ [index: string]: number }'
    - List<GenericType<Innertype>> -> 'GenericType<InnerType>[]'
    Returns:
    
    String representing this Instance of TypeNode
    
    See Also:
    
    getTypeName()
  - getVariableType
```
public String getVariableType()
```
  - getTemplate
```
public abstract String getTemplate()
```
    Classpath to the Freemarker Template which is used to generate this TypeNode.
    
    Returns:
    
    Path to template
  - getTypeParameters
```
public abstract List<TypeNode> getTypeParameters()
```
    Typeparameters are bound Generics as in GenericType<BoundType>. For example Type<TypeOne, TypeTwo> results in a List with the two Entries with TypeNodes for 'TypeOne' and 'TypeTwo'.
    
    Returns:
    
    all bound TypeParameters
  - getChildren
```
public abstract List<TypeNode> getChildren()
```
  - getTypes
```
public abstract Set<TypeNode> getTypes()
```
  - getImports
```
public abstract Set<TypeNode> getImports()
```
  - getEnumValues
```
public Set<EnumValue> getEnumValues()
```
  - isMappedType
```
public boolean isMappedType()
```
    Returns true if this TypeNode is a mapped Type.
    
    Returns:
    
    true if mapped false otherwise
  - isDeclaredComplexType
```
public boolean isDeclaredComplexType()
```
  - isOptional
```
public boolean isOptional()
```
    Returns wether this TypeNode is an optional Parameter or not.
    
    Returns:
    
    true if this TypeNode is wrapped in an Optional or is declared as not required in the respective Annotation
    false in all other cases.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class TypeNode

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getKind

getFieldName

getParameterName

getAsFunctionParameter

getAsVariableName

getTypeName

getTypeNameVariable

getType

getVariableType

getTemplate

getTypeParameters

getChildren

getTypes

getImports

getEnumValues

isMappedType

isDeclaredComplexType

isOptional

equals

hashCode