org.jooq.util

Class DefaultGeneratorStrategy

java.lang.Object

org.jooq.util.AbstractGeneratorStrategy

org.jooq.util.DefaultGeneratorStrategy

All Implemented Interfaces:

GeneratorStrategy

public class DefaultGeneratorStrategy
extends AbstractGeneratorStrategy

The default naming strategy for the JavaGenerator

Author:

Lukas Eder

Nested Class Summary

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

GeneratorStrategy.Mode

Constructor Summary

Constructors

Constructor and Description
DefaultGeneratorStrategy()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getInstanceFields() Whether fields are instance fields (as opposed to static fields)
String	getJavaClassExtends(Definition definition, GeneratorStrategy.Mode mode)
List<String>	getJavaClassImplements(Definition definition, GeneratorStrategy.Mode mode)
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 singleton 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.
String	getOverloadSuffix(Definition definition, GeneratorStrategy.Mode mode, String overloadIndex)
String	getTargetDirectory() The target directory
String	getTargetPackage()
void	setInstanceFields(boolean instanceFields) Whether fields are instance fields (as opposed to static fields)
void	setTargetDirectory(String directory) Initialise the target directory
void	setTargetPackage(String packageName) Initialise the target package name

Methods inherited from class org.jooq.util.AbstractGeneratorStrategy

getFile, getFile, getFileName, getFileName, getFullJavaClassName, getFullJavaClassName, getFullJavaIdentifier, getFullJavaIdentifiers, getFullJavaIdentifiers, getJavaClassExtends, getJavaClassImplements, getJavaClassName, 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 Detail

DefaultGeneratorStrategy

public DefaultGeneratorStrategy()

Method Detail

setInstanceFields

public final void setInstanceFields(boolean instanceFields)

Description copied from interface: GeneratorStrategy

Whether fields are instance fields (as opposed to static fields)

getInstanceFields

public final boolean getInstanceFields()

Description copied from interface: GeneratorStrategy

Whether fields are instance fields (as opposed to static fields)

getTargetDirectory

public final String getTargetDirectory()

Description copied from interface: GeneratorStrategy

The target directory

setTargetDirectory

public final void setTargetDirectory(String directory)

Description copied from interface: GeneratorStrategy

Initialise the target directory

getTargetPackage

public final String getTargetPackage()

Returns:

Get the target package for the current configuration

setTargetPackage

public final void setTargetPackage(String packageName)

Description copied from interface: GeneratorStrategy

Initialise the target package name

getJavaIdentifier

public String getJavaIdentifier(Definition definition)

Description copied from interface: GeneratorStrategy

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

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

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

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

Returns:

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

getJavaClassExtends

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

Returns:

The super class name of the Java class representing this object, e.g. [com.example.AbstractPojo]. If this returns null or an empty string, then no super class is extended.

getJavaClassImplements

public List<String> getJavaClassImplements(Definition definition,
                                  GeneratorStrategy.Mode mode)

Returns:

The implemented interface names of the Java class name representing this object, e.g. [com.example.Pojo]. If this returns null or an empty list, then no interfaces are implemented.

getJavaClassName

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

Returns:

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

getJavaPackageName

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

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

Returns:

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

getOverloadSuffix

public String getOverloadSuffix(Definition definition,
                       GeneratorStrategy.Mode mode,
                       String overloadIndex)

Returns:

The overload suffix to be applied when generating overloaded routine artefacts, e.g. "_OverloadIndex_" + overloadIndex