com.fortyoneconcepts.valjogen.model

Class Method

java.lang.Object

com.fortyoneconcepts.valjogen.model.ModelBase

com.fortyoneconcepts.valjogen.model.DefinitionBase

com.fortyoneconcepts.valjogen.model.Method

All Implemented Interfaces:

Definition, Model

Direct Known Subclasses:

Constructor, FactoryMethod, Property

public class Method
extends DefinitionBase

Meta-information about an existing method or a method that should be generated (implemented).

Field Summary

Fields

Modifier and Type	Field and Description
protected Type	declaringType
protected ImplementationInfo	implementationInfo
protected String	javaDoc
protected EnumSet<Modifier>	modifiers
protected Optional<Method>	overriddenByMethod
protected Optional<Method>	overridesMethod
protected List<Parameter>	parameters
protected Type	returnType
protected String	templateName
protected List<Type>	thrownTypes

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

annotations, clazz, declaredModifiers, name

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

MAX_RECURSIVE_LEVEL, NO_DETAILS_LEVEL

Constructor Summary

Constructors

Constructor and Description
Method(BasicClazz clazz, Type declaringType, String methodName, Type returnType, List<Parameter> parameters, List<Type> thrownTypes, String javaDoc, EnumSet<Modifier> declaredModifiers, EnumSet<Modifier> modifiers, List<Annotation> annotations, ImplementationInfo implementationInfo, TemplateKind templateKind)
Method(BasicClazz clazz, Type declaringType, String methodName, Type returnType, List<Parameter> parameters, List<Type> thrownTypes, String javaDoc, EnumSet<Modifier> declaredModifiers, List<Annotation> annotations, ImplementationInfo implementationInfo, TemplateKind templateKind)

Method Summary

Modifier and Type	Method and Description
private static EnumSet<Modifier>	defaultModifiers(Configuration cfg, EnumSet<Modifier> declaredModifiers)
Type	getDeclaringType()
ImplementationInfo	getImplementationInfo()
String	getJavaDoc()
EnumSet<Modifier>	getModifiers() Get modifiers as they should be used generated code when defining something.
String	getOverloadName() Return The name of the method with unqualified type names in parenthesis.
static String	getOverloadName(String methodName, List<Parameter> parameters)
Optional<Method>	getOverriddenByMethod()
Optional<Method>	getOverridesMethod()
String	getPackageName() The package that the output belongs to.
List<Parameter>	getParameters()
String	getQualifiedName()
Type	getReturnType()
String	getTemplateName() Return The name of the method followed by underscore seperated unqualified type names in parenthesis.
List<Type>	getThrownTypes()
boolean	isConstructor() Checks if the method is a constructor method.
boolean	isDeclared()
boolean	isDelegating()
boolean	isFactoryMethod() Checks if the method is a static factory method.
boolean	isOverridden()
boolean	isPrimary() Checks if the method is the most complete creation method and thus the one to use for construction .
boolean	isThisReturnType()
void	print(IndentedPrintWriter writer, int detailLevel) Helper method for printing out the model nicely without getting into problems with its circular references.
void	setImplementationInfo(ImplementationInfo implementationInfo)
void	setOverriddenByMethod(Method overriddenByMethod)

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

getAnnotations, getClazz, getConfiguration, getDeclaredModifiers, getName

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

printExtraBottom, printExtraTop, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

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

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

getGeneratedClazz, getVariablesPrefix, isInDefaultPackage

Field Detail

declaringType

protected final Type declaringType

parameters

protected final List<Parameter> parameters

thrownTypes

protected final List<Type> thrownTypes

javaDoc

protected final String javaDoc

returnType

protected final Type returnType

modifiers

protected final EnumSet<Modifier> modifiers

templateName

protected final String templateName

implementationInfo

protected ImplementationInfo implementationInfo

overriddenByMethod

protected Optional<Method> overriddenByMethod

overridesMethod

protected Optional<Method> overridesMethod

Constructor Detail

Method

public Method(BasicClazz clazz,
              Type declaringType,
              String methodName,
              Type returnType,
              List<Parameter> parameters,
              List<Type> thrownTypes,
              String javaDoc,
              EnumSet<Modifier> declaredModifiers,
              List<Annotation> annotations,
              ImplementationInfo implementationInfo,
              TemplateKind templateKind)

Method

public Method(BasicClazz clazz,
              Type declaringType,
              String methodName,
              Type returnType,
              List<Parameter> parameters,
              List<Type> thrownTypes,
              String javaDoc,
              EnumSet<Modifier> declaredModifiers,
              EnumSet<Modifier> modifiers,
              List<Annotation> annotations,
              ImplementationInfo implementationInfo,
              TemplateKind templateKind)

Method Detail

defaultModifiers

private static EnumSet<Modifier> defaultModifiers(Configuration cfg,
                                                  EnumSet<Modifier> declaredModifiers)

getPackageName

public String getPackageName()

Description copied from interface: Model

The package that the output belongs to.

Returns:

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

getImplementationInfo

public ImplementationInfo getImplementationInfo()

setImplementationInfo

public void setImplementationInfo(ImplementationInfo implementationInfo)

setOverriddenByMethod

public void setOverriddenByMethod(Method overriddenByMethod)

getOverriddenByMethod

public Optional<Method> getOverriddenByMethod()

getOverridesMethod

public Optional<Method> getOverridesMethod()

isOverridden

public final boolean isOverridden()

isFactoryMethod

public boolean isFactoryMethod()

Checks if the method is a static factory method.

Returns:

True if the method is a factory method.

isConstructor

public boolean isConstructor()

Checks if the method is a constructor method.

Returns:

True if the method is a factory method.

isPrimary

public boolean isPrimary()

Checks if the method is the most complete creation method and thus the one to use for construction .

Returns:

True if the method is a primary method to use for construction.

isThisReturnType

public boolean isThisReturnType()

getReturnType

public Type getReturnType()

isDeclared

public boolean isDeclared()

getDeclaringType

public Type getDeclaringType()

getModifiers

public EnumSet<Modifier> getModifiers()

Description copied from interface: Definition

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

Returns:

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

getQualifiedName

public String getQualifiedName()

getOverloadName

public String getOverloadName()

Return The name of the method with unqualified type names in parenthesis. All type names are unqualified so not guarenteed to be unique.

Returns:

The string suitable for overload resolution.

getOverloadName

public static final String getOverloadName(String methodName,
                                           List<Parameter> parameters)

getTemplateName

public final String getTemplateName()

Return The name of the method followed by underscore seperated unqualified type names in parenthesis. All type names are unqualified so not guarenteed to be unique.

Returns:

The string with the name of the template that corresponds to the method.

getParameters

public List<Parameter> getParameters()

getThrownTypes

public List<Type> getThrownTypes()

getJavaDoc

public String getJavaDoc()

isDelegating

public boolean isDelegating()

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

Specified by:

print in class ModelBase

Parameters:

writer - The writer to print to

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