com.fortyoneconcepts.valjogen.model

Class FactoryMethod

java.lang.Object

com.fortyoneconcepts.valjogen.model.ModelBase

com.fortyoneconcepts.valjogen.model.DefinitionBase

com.fortyoneconcepts.valjogen.model.Method

com.fortyoneconcepts.valjogen.model.FactoryMethod

All Implemented Interfaces:

Definition, Model

public class FactoryMethod
extends Method

Meta-information about a factory method.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	primary Tells if this factory method is the most complete one and this the one to use for data conversions etc.

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

declaringType, implementationInfo, javaDoc, modifiers, overriddenByMethod, overridesMethod, parameters, returnType, templateName, 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
FactoryMethod(BasicClazz clazz, Type declaringType, String methodName, Type returnType, List<Parameter> parameters, List<Type> thrownTypes, String javaDoc, boolean primary, EnumSet<Modifier> declaredModifiers, EnumSet<Modifier> modifiers, List<Annotation> annotations, ImplementationInfo implementationInfo, TemplateKind templateKind)
FactoryMethod(BasicClazz clazz, Type declaringType, String methodName, Type returnType, List<Parameter> parameters, List<Type> thrownTypes, String javaDoc, boolean primary, EnumSet<Modifier> declaredModifiers, List<Annotation> annotations, ImplementationInfo implementationInfo, TemplateKind templateKind)

Method Summary

Modifier and Type	Method and Description
boolean	isFactoryMethod() Checks if the method is a static factory method.
boolean	isPrimary() Checks if the method is the most complete creation method and thus the one to use for construction .

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

getDeclaringType, getImplementationInfo, getJavaDoc, getModifiers, getOverloadName, getOverloadName, getOverriddenByMethod, getOverridesMethod, getPackageName, getParameters, getQualifiedName, getReturnType, getTemplateName, getThrownTypes, isConstructor, isDeclared, isDelegating, isOverridden, isThisReturnType, print, setImplementationInfo, setOverriddenByMethod

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

primary

private final boolean primary

Tells if this factory method is the most complete one and this the one to use for data conversions etc.

Constructor Detail

FactoryMethod

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

FactoryMethod

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

Method Detail

isFactoryMethod

public boolean isFactoryMethod()

Description copied from class: Method

Checks if the method is a static factory method.

Overrides:

isFactoryMethod in class Method

Returns:

True if the method is a factory method.

isPrimary

public boolean isPrimary()

Description copied from class: Method

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

Overrides:

isPrimary in class Method

Returns:

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