Module org.jooq.codegen

Package org.jooq.codegen.example

Class JVMArgsGeneratorStrategy

java.lang.Object

org.jooq.codegen.AbstractGeneratorStrategy

org.jooq.codegen.DefaultGeneratorStrategy

org.jooq.codegen.example.JVMArgsGeneratorStrategy

All Implemented Interfaces:

GeneratorStrategy

public class JVMArgsGeneratorStrategy
extends DefaultGeneratorStrategy

A generator strategy that prefixes / suffixes class names and other artefacts with values taken from JVM parameters.

An example variant of the default naming strategy DefaultGeneratorStrategy adding the prefix and suffixes to generated class names (e.g. to avoid name clashes with existing JPA entities and such).

The following JVM parameters are supported:

• org.jooq.meta.example.java-identifier-prefix
• org.jooq.meta.example.java-identifier-suffix
• org.jooq.meta.example.java-getter-name-prefix
• org.jooq.meta.example.java-getter-name-suffix
• org.jooq.meta.example.java-setter-name-prefix
• org.jooq.meta.example.java-setter-name-suffix
• org.jooq.meta.example.java-method-name-prefix
• org.jooq.meta.example.java-method-name-suffix
• org.jooq.meta.example.java-class-name-prefix
• org.jooq.meta.example.java-class-name-suffix
• org.jooq.meta.example.java-package-name-prefix
• org.jooq.meta.example.java-package-name-suffix
• org.jooq.meta.example.java-member-name-prefix
• org.jooq.meta.example.java-member-name-suffix

This strategy is to be understood as a working example, not part of the code generation library. It may be modified / adapted in the future. Use at your own risk.

Author:

Lukas Eder

Nested Class Summary

Nested classes/interfaces inherited from interface org.jooq.codegen.GeneratorStrategy

GeneratorStrategy.Mode

Constructor Summary

Constructors

Constructor	Description
JVMArgsGeneratorStrategy()

Method Summary

Modifier and Type	Method	Description
String	getJavaClassName(Definition definition, GeneratorStrategy.Mode mode)
String	getJavaGetterName(Definition definition, GeneratorStrategy.Mode mode)	This is applied to definitions that can result in getters of a container.
String	getJavaIdentifier(Definition definition)	This is applied to definitions that can result in reference static and instance members.
String	getJavaMemberName(Definition definition, GeneratorStrategy.Mode mode)	The "java member name" is applied where a definition is used as a member (for POJOs) or as a method argument (for setters).
String	getJavaMethodName(Definition definition, GeneratorStrategy.Mode mode)	This is applied to definitions that can result in methods.
String	getJavaPackageName(Definition definition, GeneratorStrategy.Mode mode)
String	getJavaSetterName(Definition definition, GeneratorStrategy.Mode mode)	This is applied to definitions that can result in setters of a container.

Methods inherited from class org.jooq.codegen.DefaultGeneratorStrategy

getFileHeader, getGlobalReferencesFileHeader, getGlobalReferencesJavaClassExtends, getGlobalReferencesJavaClassImplements, getGlobalReferencesJavaClassName, getGlobalReferencesJavaPackageName, getInstanceFields, getJavaBeansGettersAndSetters, getJavaClassExtends, getJavaClassImplements, getJavaEnumLiteral, getOverloadSuffix, getTargetDirectory, getTargetLanguage, getTargetLocale, getTargetPackage, getUseTableNameForUnambiguousFKs, setInstanceFields, setJavaBeansGettersAndSetters, setTargetDirectory, setTargetLanguage, setTargetLocale, setTargetPackage, setUseTableNameForUnambiguousFKs

Methods inherited from class org.jooq.codegen.AbstractGeneratorStrategy

getFile, getFile, getFile, getFileHeader, getFileName, getFileName, getFileRoot, getFullJavaClassName, getFullJavaClassName, getFullJavaIdentifier, getFullJavaIdentifiers, getFullJavaIdentifiers, getGlobalReferencesFile, getGlobalReferencesFileName, getGlobalReferencesFullJavaClassName, getJavaClassExtends, getJavaClassImplements, getJavaClassName, getJavaEnumLiterals, getJavaEnumLiterals, getJavaGetterName, getJavaIdentifiers, getJavaIdentifiers, getJavaMemberName, getJavaMethodName, getJavaPackageName, getJavaSetterName

Methods inherited from class java.lang.Object

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

Constructor Details

JVMArgsGeneratorStrategy

public JVMArgsGeneratorStrategy()

Method Details

getJavaIdentifier

public String getJavaIdentifier(Definition definition)

Description copied from interface: GeneratorStrategy

This is applied to definitions that can result in reference static and instance members. For instance, the reference instance of a TableDefinition is a java identifier

Specified by:

getJavaIdentifier in interface GeneratorStrategy

Overrides:

getJavaIdentifier in class DefaultGeneratorStrategy

Returns:

The Java identifier representing this object, e.g. [my_table]

getJavaSetterName

public String getJavaSetterName(Definition definition,
 GeneratorStrategy.Mode mode)

Description copied from interface: GeneratorStrategy

This is applied to definitions that can result in setters of a container. For example, the definition could be a ColumnDefinition, the container a TableDefinition. Then this would apply to records and POJOs. Also, the definition could be an AttributeDefinition and the container a UDTDefinition

Specified by:

getJavaSetterName in interface GeneratorStrategy

Overrides:

getJavaSetterName in class DefaultGeneratorStrategy

Returns:

The Java setter method name representing this object, e.g. [setMyTable]

getJavaGetterName

public String getJavaGetterName(Definition definition,
 GeneratorStrategy.Mode mode)

Description copied from interface: GeneratorStrategy

This is applied to definitions that can result in getters of a container. For example, the definition could be a ColumnDefinition, the container a TableDefinition. Then this would apply to records and POJOs. Also, the definition could be an AttributeDefinition and the container a UDTDefinition

Specified by:

getJavaGetterName in interface GeneratorStrategy

Overrides:

getJavaGetterName in class DefaultGeneratorStrategy

Returns:

The Java getter method name representing this object, e.g. [getMyTable]

getJavaMethodName

public String getJavaMethodName(Definition definition,
 GeneratorStrategy.Mode mode)

Description copied from interface: GeneratorStrategy

This is applied to definitions that can result in methods. For example, the definition could be a RoutineDefinition

Specified by:

getJavaMethodName in interface GeneratorStrategy

Overrides:

getJavaMethodName in class DefaultGeneratorStrategy

Returns:

The Java method name representing this object, e.g. [myFunction]

getJavaClassName

public String getJavaClassName(Definition definition,
 GeneratorStrategy.Mode mode)

Specified by:

getJavaClassName in interface GeneratorStrategy

Overrides:

getJavaClassName in class DefaultGeneratorStrategy

Returns:

The Java class name representing this object, e.g. [MyTableSuffix]

getJavaPackageName

public String getJavaPackageName(Definition definition,
 GeneratorStrategy.Mode mode)

Specified by:

getJavaPackageName in interface GeneratorStrategy

Overrides:

getJavaPackageName in class DefaultGeneratorStrategy

Returns:

The Java package name of this object, e.g. [org.jooq.generated]

getJavaMemberName

public String getJavaMemberName(Definition definition,
 GeneratorStrategy.Mode mode)

Description copied from interface: GeneratorStrategy

The "java member name" is applied where a definition is used as a member (for POJOs) or as a method argument (for setters). Example definitions are

• ColumnDefinition
• ParameterDefinition
• AttributeDefinition

Specified by:

getJavaMemberName in interface GeneratorStrategy

Overrides:

getJavaMemberName in class DefaultGeneratorStrategy

Returns:

The Java class name representing this object, starting with a lower case character, e.g. [myTableSuffix]