org.nuiton.eugene.java

Class JavaTemplatesStereoTypes

java.lang.Object

org.nuiton.eugene.models.stereotype.StereotypeDefinitionProvider

org.nuiton.eugene.java.JavaTemplatesStereoTypes

public class JavaTemplatesStereoTypes
extends StereotypeDefinitionProvider

Defines all stereotypes managed by Java templates.

Since:

2.5.6

Author:

Tony Chemit - chemit@codelutin.com

Plexus component:

role: "org.nuiton.eugene.models.stereotype.StereotypeDefinitionProvider" role-hint: "eugene-java-templates"

Field Summary

Fields

Modifier and Type	Field and Description
static String	STEREOTYPE_ACCEPT_BEAN_WITH_METHODS Tag value to authorize user to generate some bean with methods, some generators won't generate them : Lots code).
static String	STEREOTYPE_BEAN Stereotype for JavaBean objects to place on a classifier.
static String	STEREOTYPE_OVERRIDE_ABSTRACT_CLASSES Tag value to authorize user to override abstract classes.
static String	STEREOTYPE_SIMPLE_BEAN_SKIP_GENERATE_DEFAULTS To generate a factory of generated simple beans.
static String	STEREOTYPE_SIMPLE_BEAN_SKIP_GENERATE_FACTORY To generate a factory of generated simple beans.
static String	STEREOTYPE_SIMPLE_BEAN_SKIP_GENERATE_INTERFACE To generate an interface of each simple bean.
static String	STEREOTYPE_SIMPLE_BEAN_WITH_NO_INTERFACE_SKIP_GENERATE_DEFAULT_CONSTRUCTORS To generate or not constructors methods on Default classes.
static String	STEREOTYPE_SIMPLE_BEAN_WITH_NO_INTERFACE_SKIP_GENERATE_DEFAULTS To generate a factory of generated simple beans.
static String	STEREOTYPE_SIMPLE_BEAN_WITH_NO_INTERFACE_SKIP_GENERATE_FUNCTIONS To generate or not guava functions on each property of the bean.
static String	STEREOTYPE_SIMPLE_BEAN_WITH_NO_INTERFACE_SKIP_GENERATE_PREDICATES To generate or not guava predicates on each property of the bean.
static String	STEREOTYPE_SKIP_GENERATE_NOT_EMPTY_COLLECTIONS Tag value to generate lazy instanciation of any collection to avoid NPEs.
static String	STEREOTYPE_SKIP_GENERATE_PROPERTY_CHANGE_SUPPORT Tag value to generate property change support on generated beans.

Fields inherited from class org.nuiton.eugene.models.stereotype.StereotypeDefinitionProvider

definition, deprecated, verbose

Constructor Summary

Constructors

Constructor and Description
JavaTemplatesStereoTypes()

Method Summary

Modifier and Type	Method and Description
static boolean	hasBeanStereotype(ObjectModelClassifier classifier, ObjectModelPackage aPackage) Check if the given classifier has the STEREOTYPE_BEAN stereotype.
static boolean	hasBeanStereotype(ObjectModelPackage aPackage) Check if the given aPackage has the STEREOTYPE_BEAN stereotype.
boolean	isAcceptBeanWithMethods(ObjectModelClassifier classifier, ObjectModelPackage aPackage, ObjectModel model) Obtain the value of the STEREOTYPE_ACCEPT_BEAN_WITH_METHODS tag value on the given model, package or classifier.
boolean	isOverrideAbstractClasses(ObjectModelClassifier classifier, ObjectModelPackage aPackage, ObjectModel model) Obtain the value of the STEREOTYPE_OVERRIDE_ABSTRACT_CLASSES tag value on the given model, package or classifier.
boolean	isSimpleBeanSkipGenerateDefaults(ObjectModelClassifier classifier, ObjectModelPackage aPackage, ObjectModel model) Obtain the value of the STEREOTYPE_SIMPLE_BEAN_SKIP_GENERATE_DEFAULTS tag value on the given model or classifier.
boolean	isSimpleBeanSkipGenerateFactory(ObjectModel model) Obtain the value of the STEREOTYPE_SIMPLE_BEAN_SKIP_GENERATE_FACTORY tag value on the given model or classifier.
boolean	isSimpleBeanSkipGenerateInterface(ObjectModelClassifier classifier, ObjectModelPackage aPackage, ObjectModel model) Obtain the value of the STEREOTYPE_SIMPLE_BEAN_SKIP_GENERATE_INTERFACE tag value on the given model or classifier.
boolean	isSimpleBeanWithNoInterfaceSkipGenerateDefaultConstructors(ObjectModelClassifier classifier, ObjectModelPackage aPackage, ObjectModel model) Obtain the value of the STEREOTYPE_SIMPLE_BEAN_WITH_NO_INTERFACE_SKIP_GENERATE_DEFAULT_CONSTRUCTORS tag value on the given model or classifier.
boolean	isSimpleBeanWithNoInterfaceSkipGenerateDefaults(ObjectModelClassifier classifier, ObjectModelPackage aPackage, ObjectModel model) Obtain the value of the STEREOTYPE_SIMPLE_BEAN_WITH_NO_INTERFACE_SKIP_GENERATE_DEFAULTS tag value on the given model or classifier.
boolean	isSimpleBeanWithNoInterfaceSkipGenerateFunctions(ObjectModelClassifier classifier, ObjectModelPackage aPackage, ObjectModel model) Obtain the value of the STEREOTYPE_SIMPLE_BEAN_WITH_NO_INTERFACE_SKIP_GENERATE_FUNCTIONS tag value on the given model or classifier.
boolean	isSimpleBeanWithNoInterfaceSkipGeneratePredicates(ObjectModelClassifier classifier, ObjectModelPackage aPackage, ObjectModel model) Obtain the value of the STEREOTYPE_SIMPLE_BEAN_WITH_NO_INTERFACE_SKIP_GENERATE_PREDICATES tag value on the given model or classifier.
boolean	isSkipGenerateNotEmptyCollections(ObjectModelClassifier classifier, ObjectModelPackage aPackage, ObjectModel model) Obtain the value of the STEREOTYPE_SKIP_GENERATE_NOT_EMPTY_COLLECTIONS tag value on the given model, package or classifier.
boolean	isSkipGeneratePropertyChangeSupport(ObjectModelClassifier classifier, ObjectModelPackage aPackage, ObjectModel model) Obtain the value of the STEREOTYPE_SKIP_GENERATE_PROPERTY_CHANGE_SUPPORT tag value on the given model, package or classifier.

Methods inherited from class org.nuiton.eugene.models.stereotype.StereotypeDefinitionProvider

addAllDefinition, addAllDeprecated, addDefinition, addDeprecated, getDefinition, getDefinition, init, initDefinition, isDeprecated, isVerbose, scanClass, setVerbose, validate

Methods inherited from class java.lang.Object

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

Field Detail

STEREOTYPE_BEAN

public static final String STEREOTYPE_BEAN

Stereotype for JavaBean objects to place on a classifier.

Since:

2.5.6

See Also:

hasBeanStereotype(ObjectModelClassifier, ObjectModelPackage), hasBeanStereotype(ObjectModelPackage), Constant Field Values

STEREOTYPE_ACCEPT_BEAN_WITH_METHODS

public static final String STEREOTYPE_ACCEPT_BEAN_WITH_METHODS

Tag value to authorize user to generate some bean with methods, some generators won't generate them : Lots code). By default, user should never add methods in bean classes, simply write them in your java code!. You can globaly use it on the complete model, on packages, or to a specific classifier.

Since:

3.0

See Also:

isAcceptBeanWithMethods(ObjectModelClassifier, ObjectModelPackage, ObjectModel), Constant Field Values

STEREOTYPE_OVERRIDE_ABSTRACT_CLASSES

public static final String STEREOTYPE_OVERRIDE_ABSTRACT_CLASSES

Tag value to authorize user to override abstract classes. By default, user should never override abstract classes but works on implementation ones. You can globaly use it on the complete model, on packages, or to a specific classifier.

Since:

3.0

See Also:

isOverrideAbstractClasses(ObjectModelClassifier, ObjectModelPackage, ObjectModel), Constant Field Values

STEREOTYPE_SKIP_GENERATE_PROPERTY_CHANGE_SUPPORT

public static final String STEREOTYPE_SKIP_GENERATE_PROPERTY_CHANGE_SUPPORT

Tag value to generate property change support on generated beans. You can globaly use it on the complete model, on packages, or to a specific classifier.

Since:

2.12

See Also:

isSkipGeneratePropertyChangeSupport(ObjectModelClassifier, ObjectModelPackage, ObjectModel), Constant Field Values

STEREOTYPE_SKIP_GENERATE_NOT_EMPTY_COLLECTIONS

public static final String STEREOTYPE_SKIP_GENERATE_NOT_EMPTY_COLLECTIONS

Tag value to generate lazy instanciation of any collection to avoid NPEs. You can globaly use it on the complete model or a package, or to a specific classifier.

Since:

2.12

See Also:

isSkipGenerateNotEmptyCollections(ObjectModelClassifier, ObjectModelPackage, ObjectModel), Constant Field Values

STEREOTYPE_SIMPLE_BEAN_SKIP_GENERATE_INTERFACE

public static final String STEREOTYPE_SIMPLE_BEAN_SKIP_GENERATE_INTERFACE

To generate an interface of each simple bean. You can globaly use it on the complete model or to a specific classifier.

Since:

2.6.2

See Also:

isSimpleBeanSkipGenerateInterface(ObjectModelClassifier, ObjectModelPackage, ObjectModel), Constant Field Values

STEREOTYPE_SIMPLE_BEAN_SKIP_GENERATE_FACTORY

public static final String STEREOTYPE_SIMPLE_BEAN_SKIP_GENERATE_FACTORY

To generate a factory of generated simple beans. You must use it on the complete model.

Since:

2.6.2

See Also:

isSimpleBeanSkipGenerateFactory(ObjectModel), Constant Field Values

STEREOTYPE_SIMPLE_BEAN_SKIP_GENERATE_DEFAULTS

public static final String STEREOTYPE_SIMPLE_BEAN_SKIP_GENERATE_DEFAULTS

To generate a factory of generated simple beans. You must use it on the complete model.

Since:

2.7.2

See Also:

isSimpleBeanSkipGenerateDefaults(ObjectModelClassifier, ObjectModelPackage, ObjectModel), Constant Field Values

STEREOTYPE_SIMPLE_BEAN_WITH_NO_INTERFACE_SKIP_GENERATE_DEFAULTS

public static final String STEREOTYPE_SIMPLE_BEAN_WITH_NO_INTERFACE_SKIP_GENERATE_DEFAULTS

To generate a factory of generated simple beans. You must use it on the complete model.

Since:

3.0

See Also:

isSimpleBeanWithNoInterfaceSkipGenerateDefaults(ObjectModelClassifier, ObjectModelPackage, ObjectModel), Constant Field Values

STEREOTYPE_SIMPLE_BEAN_WITH_NO_INTERFACE_SKIP_GENERATE_PREDICATES

public static final String STEREOTYPE_SIMPLE_BEAN_WITH_NO_INTERFACE_SKIP_GENERATE_PREDICATES

To generate or not guava predicates on each property of the bean. You can globaly use it on the complete model or to a specific classifier.

Since:

3.0

See Also:

isSimpleBeanWithNoInterfaceSkipGeneratePredicates(ObjectModelClassifier, ObjectModelPackage, ObjectModel), Constant Field Values

STEREOTYPE_SIMPLE_BEAN_WITH_NO_INTERFACE_SKIP_GENERATE_FUNCTIONS

public static final String STEREOTYPE_SIMPLE_BEAN_WITH_NO_INTERFACE_SKIP_GENERATE_FUNCTIONS

To generate or not guava functions on each property of the bean. You can globaly use it on the complete model or to a specific classifier.

Since:

3.0

See Also:

isSimpleBeanWithNoInterfaceSkipGenerateFunctions(ObjectModelClassifier, ObjectModelPackage, ObjectModel), Constant Field Values

STEREOTYPE_SIMPLE_BEAN_WITH_NO_INTERFACE_SKIP_GENERATE_DEFAULT_CONSTRUCTORS

public static final String STEREOTYPE_SIMPLE_BEAN_WITH_NO_INTERFACE_SKIP_GENERATE_DEFAULT_CONSTRUCTORS

To generate or not constructors methods on Default classes. You can globaly use it on the complete model, package or on a specific classifier.

Since:

3.0

See Also:

isSimpleBeanWithNoInterfaceSkipGenerateDefaultConstructors(ObjectModelClassifier, ObjectModelPackage, ObjectModel)}, Constant Field Values

Constructor Detail

JavaTemplatesStereoTypes

public JavaTemplatesStereoTypes()

Method Detail

hasBeanStereotype

public static boolean hasBeanStereotype(ObjectModelClassifier classifier,
                                        ObjectModelPackage aPackage)

Check if the given classifier has the STEREOTYPE_BEAN stereotype.

Parameters:

classifier - classifier to test

Returns:

true if stereotype was found, false otherwise

See Also:

STEREOTYPE_BEAN

hasBeanStereotype

public static boolean hasBeanStereotype(ObjectModelPackage aPackage)

Check if the given aPackage has the STEREOTYPE_BEAN stereotype.

Parameters:

aPackage - classifier to test

Returns:

true if stereotype was found, false otherwise

See Also:

STEREOTYPE_BEAN

isAcceptBeanWithMethods

public boolean isAcceptBeanWithMethods(ObjectModelClassifier classifier,
                                       ObjectModelPackage aPackage,
                                       ObjectModel model)

Obtain the value of the STEREOTYPE_ACCEPT_BEAN_WITH_METHODS tag value on the given model, package or classifier. It will first look on the model, then and package and then in the given classifier. If no value found, then will use the default value of the tag value.

Parameters:

classifier - classifier to seek

aPackage - package to seek

model - model to seek

Returns:

the none empty value of the found tag value or null if not found nor empty.

Since:

3.0

See Also:

STEREOTYPE_ACCEPT_BEAN_WITH_METHODS

isOverrideAbstractClasses

public boolean isOverrideAbstractClasses(ObjectModelClassifier classifier,
                                         ObjectModelPackage aPackage,
                                         ObjectModel model)

Obtain the value of the STEREOTYPE_OVERRIDE_ABSTRACT_CLASSES tag value on the given model, package or classifier. It will first look on the model, then and package and then in the given classifier. If no value found, then will use the default value of the tag value.

Parameters:

classifier - classifier to seek

aPackage - package to seek

model - model to seek

Returns:

the none empty value of the found tag value or null if not found nor empty.

Since:

3.0

See Also:

STEREOTYPE_OVERRIDE_ABSTRACT_CLASSES

isSkipGeneratePropertyChangeSupport

public boolean isSkipGeneratePropertyChangeSupport(ObjectModelClassifier classifier,
                                                   ObjectModelPackage aPackage,
                                                   ObjectModel model)

Obtain the value of the STEREOTYPE_SKIP_GENERATE_PROPERTY_CHANGE_SUPPORT tag value on the given model, package or classifier. It will first look on the model, then and package and then in the given classifier. If no value found, then will use the default value of the tag value.

Parameters:

classifier - classifier to seek

aPackage - package to seek

model - model to seek

Returns:

the none empty value of the found tag value or null if not found nor empty.

Since:

2.12

See Also:

STEREOTYPE_SKIP_GENERATE_PROPERTY_CHANGE_SUPPORT

isSkipGenerateNotEmptyCollections

public boolean isSkipGenerateNotEmptyCollections(ObjectModelClassifier classifier,
                                                 ObjectModelPackage aPackage,
                                                 ObjectModel model)

Obtain the value of the STEREOTYPE_SKIP_GENERATE_NOT_EMPTY_COLLECTIONS tag value on the given model, package or classifier. It will first look on the model, then and package and then in the given classifier. If no value found, then will use the default value of the tag value.

Parameters:

classifier - classifier to seek

aPackage - package to seek

model - model to seek

Returns:

the none empty value of the found tag value or null if not found nor empty.

Since:

2.12

See Also:

STEREOTYPE_SKIP_GENERATE_NOT_EMPTY_COLLECTIONS

isSimpleBeanSkipGenerateInterface

public boolean isSimpleBeanSkipGenerateInterface(ObjectModelClassifier classifier,
                                                 ObjectModelPackage aPackage,
                                                 ObjectModel model)

Obtain the value of the STEREOTYPE_SIMPLE_BEAN_SKIP_GENERATE_INTERFACE tag value on the given model or classifier. It will first look on the model, and then in the given classifier.

Parameters:

classifier - classifier to seek

model - model to seek

Returns:

the none empty value of the found tag value or null if not found nor empty.

Since:

2.3

See Also:

STEREOTYPE_SIMPLE_BEAN_SKIP_GENERATE_INTERFACE

isSimpleBeanSkipGenerateFactory

public boolean isSimpleBeanSkipGenerateFactory(ObjectModel model)

Obtain the value of the STEREOTYPE_SIMPLE_BEAN_SKIP_GENERATE_FACTORY tag value on the given model or classifier.

Parameters:

model - model to seek

Returns:

the none empty value of the found tag value or null if not found nor empty.

Since:

2.7.2

See Also:

STEREOTYPE_SIMPLE_BEAN_SKIP_GENERATE_FACTORY

isSimpleBeanSkipGenerateDefaults

public boolean isSimpleBeanSkipGenerateDefaults(ObjectModelClassifier classifier,
                                                ObjectModelPackage aPackage,
                                                ObjectModel model)

Obtain the value of the STEREOTYPE_SIMPLE_BEAN_SKIP_GENERATE_DEFAULTS tag value on the given model or classifier. It will first look on the model, and then in the given classifier.

Parameters:

classifier - classifier to seek

model - model to seek

Returns:

the none empty value of the found tag value or null if not found nor empty.

Since:

2.7.2

See Also:

STEREOTYPE_SIMPLE_BEAN_SKIP_GENERATE_DEFAULTS

isSimpleBeanWithNoInterfaceSkipGenerateDefaults

public boolean isSimpleBeanWithNoInterfaceSkipGenerateDefaults(ObjectModelClassifier classifier,
                                                               ObjectModelPackage aPackage,
                                                               ObjectModel model)

Obtain the value of the STEREOTYPE_SIMPLE_BEAN_WITH_NO_INTERFACE_SKIP_GENERATE_DEFAULTS tag value on the given model or classifier. It will first look on the model, and then in the given classifier.

Parameters:

classifier - classifier to seek

model - model to seek

Returns:

the none empty value of the found tag value or null if not found nor empty.

Since:

3.0

See Also:

STEREOTYPE_SIMPLE_BEAN_WITH_NO_INTERFACE_SKIP_GENERATE_DEFAULTS

isSimpleBeanWithNoInterfaceSkipGeneratePredicates

public boolean isSimpleBeanWithNoInterfaceSkipGeneratePredicates(ObjectModelClassifier classifier,
                                                                 ObjectModelPackage aPackage,
                                                                 ObjectModel model)

Obtain the value of the STEREOTYPE_SIMPLE_BEAN_WITH_NO_INTERFACE_SKIP_GENERATE_PREDICATES tag value on the given model or classifier. It will first look on the model, and then in the given classifier. If not filled, then use default s value.

Parameters:

classifier - classifier to seek

model - model to seek

Returns:

the none empty value of the found tag value or null if not found nor empty.

Since:

3.0

See Also:

STEREOTYPE_SIMPLE_BEAN_WITH_NO_INTERFACE_SKIP_GENERATE_PREDICATES

isSimpleBeanWithNoInterfaceSkipGenerateFunctions

public boolean isSimpleBeanWithNoInterfaceSkipGenerateFunctions(ObjectModelClassifier classifier,
                                                                ObjectModelPackage aPackage,
                                                                ObjectModel model)

Obtain the value of the STEREOTYPE_SIMPLE_BEAN_WITH_NO_INTERFACE_SKIP_GENERATE_FUNCTIONS tag value on the given model or classifier. It will first look on the model, and then in the given classifier. If not filled, then use default s value.

Parameters:

classifier - classifier to seek

model - model to seek

Returns:

the none empty value of the found tag value or null if not found nor empty.

Since:

3.0

See Also:

STEREOTYPE_SIMPLE_BEAN_WITH_NO_INTERFACE_SKIP_GENERATE_FUNCTIONS

isSimpleBeanWithNoInterfaceSkipGenerateDefaultConstructors

public boolean isSimpleBeanWithNoInterfaceSkipGenerateDefaultConstructors(ObjectModelClassifier classifier,
                                                                          ObjectModelPackage aPackage,
                                                                          ObjectModel model)

Obtain the value of the STEREOTYPE_SIMPLE_BEAN_WITH_NO_INTERFACE_SKIP_GENERATE_DEFAULT_CONSTRUCTORS tag value on the given model or classifier. It will first look on the model, and then in the given classifier. If not filled, then use default s value.

Parameters:

classifier - classifier to seek

model - model to seek

Returns:

the none empty value of the found tag value or null if not found nor empty.

Since:

3.0

See Also:

STEREOTYPE_SIMPLE_BEAN_WITH_NO_INTERFACE_SKIP_GENERATE_DEFAULT_CONSTRUCTORS