Module org.jooq.codegen

Package org.jooq.codegen

Class AbstractGeneratorStrategy

java.lang.Object

org.jooq.codegen.AbstractGeneratorStrategy

All Implemented Interfaces:

GeneratorStrategy

Direct Known Subclasses:

DefaultGeneratorStrategy

public abstract class AbstractGeneratorStrategy
extends Object
implements GeneratorStrategy

Common base class for convenience method abstraction

Author:

Lukas Eder

Nested Class Summary

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

GeneratorStrategy.Mode

Constructor Summary

Constructors

Constructor	Description
AbstractGeneratorStrategy()

Method Summary

Modifier and Type	Method	Description
File	getFile(String fileName)
File	getFile(Definition definition)
File	getFile(Definition definition, GeneratorStrategy.Mode mode)
String	getFileHeader(Definition definition)
String	getFileName(Definition definition)
String	getFileName(Definition definition, GeneratorStrategy.Mode mode)
File	getFileRoot()
String	getFullJavaClassName(Definition definition)
String	getFullJavaClassName(Definition definition, GeneratorStrategy.Mode mode)	This is the same as calling getFullJavaClassName(definition, Mode.DEFAULT)
String	getFullJavaIdentifier(Definition definition)	This is applied to definitions that can result in reference static and instance members.
List<String>	getFullJavaIdentifiers(Collection<? extends Definition> definitions)
List<String>	getFullJavaIdentifiers(Definition... definitions)
File	getGlobalReferencesFile(Definition container, Class<? extends Definition> objectType)
String	getGlobalReferencesFileName(Definition container, Class<? extends Definition> objectType)
String	getGlobalReferencesFullJavaClassName(Definition container, Class<? extends Definition> objectType)
String	getJavaClassExtends(Definition definition)	This is the same as calling getJavaClassExtends(definition, Mode.DEFAULT)
List<String>	getJavaClassImplements(Definition definition)	This is the same as calling getJavaClassImplements(definition, Mode.DEFAULT)
String	getJavaClassName(Definition definition)	This is the same as calling getJavaClassName(definition, Mode.DEFAULT)
List<String>	getJavaEnumLiterals(EnumDefinition definition, String... literals)
List<String>	getJavaEnumLiterals(EnumDefinition definition, Collection<? extends String> literals)
String	getJavaGetterName(Definition definition)	This is applied to definitions that can result in getters of a container.
List<String>	getJavaIdentifiers(Collection<? extends Definition> definitions)
List<String>	getJavaIdentifiers(Definition... definitions)
String	getJavaMemberName(Definition definition)	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)	This is applied to definitions that can result in methods.
String	getJavaPackageName(Definition definition)	This is the same as calling getJavaPackageName(definition, Mode.DEFAULT)
String	getJavaSetterName(Definition definition)	This is applied to definitions that can result in setters of a container.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jooq.codegen.GeneratorStrategy

getFileHeader, getGlobalReferencesFileHeader, getGlobalReferencesJavaClassExtends, getGlobalReferencesJavaClassImplements, getGlobalReferencesJavaClassName, getGlobalReferencesJavaPackageName, getInstanceFields, getJavaBeansGettersAndSetters, getJavaClassExtends, getJavaClassImplements, getJavaClassName, getJavaEnumLiteral, getJavaGetterName, getJavaIdentifier, getJavaMemberName, getJavaMethodName, getJavaPackageName, getJavaSetterName, getOverloadSuffix, getTargetDirectory, getTargetLanguage, getTargetLocale, getTargetPackage, setInstanceFields, setJavaBeansGettersAndSetters, setTargetDirectory, setTargetLanguage, setTargetLocale, setTargetPackage

Constructor Detail

AbstractGeneratorStrategy

public AbstractGeneratorStrategy()

Method Detail

getGlobalReferencesFileName

public final String getGlobalReferencesFileName(Definition container,
                                                Class<? extends Definition> objectType)

Specified by:

getGlobalReferencesFileName in interface GeneratorStrategy

Returns:

The Java class file name of the global references class for a given definition type, e.g. [MyTable.java]

getFileName

public final String getFileName(Definition definition)

Specified by:

getFileName in interface GeneratorStrategy

Returns:

The Java class file name representing this object, e.g. [MyTable.java]

getFileName

public final String getFileName(Definition definition,
                                GeneratorStrategy.Mode mode)

Specified by:

getFileName in interface GeneratorStrategy

Returns:

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

getFileRoot

public final File getFileRoot()

Specified by:

getFileRoot in interface GeneratorStrategy

Returns:

The directory containing all Java objects, e.g. [C:\org\jooq\generated]

getGlobalReferencesFile

public final File getGlobalReferencesFile(Definition container,
                                          Class<? extends Definition> objectType)

Specified by:

getGlobalReferencesFile in interface GeneratorStrategy

Returns:

The Java class file name of the global references class for a given definition type, e.g. [C:\org\jooq\generated\MyTable.java]

getFile

public final File getFile(Definition definition)

Specified by:

getFile in interface GeneratorStrategy

Returns:

The Java class file name representing this object, e.g. [C:\org\jooq\generated\MyTable.java]

getFile

public final File getFile(Definition definition,
                          GeneratorStrategy.Mode mode)

Specified by:

getFile in interface GeneratorStrategy

Returns:

The Java class file name representing this object, e.g. [C:\org\jooq\generated\MyTableSuffix.java]

getFile

public final File getFile(String fileName)

Specified by:

getFile in interface GeneratorStrategy

Returns:

The Java class file name representing this object, e.g. [C:\org\jooq\generated\fileName]

getFileHeader

public final String getFileHeader(Definition definition)

Specified by:

getFileHeader in interface GeneratorStrategy

Returns:

The Java class file header, e.g.

 This file is generated by jOOQ.
 

getFullJavaIdentifier

public final String getFullJavaIdentifier(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:

getFullJavaIdentifier in interface GeneratorStrategy

Returns:

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

getJavaSetterName

public final String getJavaSetterName(Definition definition)

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

This is the same as calling getJavaSetterName(definition, Mode.DEFAULT)

Specified by:

getJavaSetterName in interface GeneratorStrategy

Returns:

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

getJavaGetterName

public final String getJavaGetterName(Definition definition)

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

This is the same as calling getJavaGetterName(definition, Mode.DEFAULT)

Specified by:

getJavaGetterName in interface GeneratorStrategy

Returns:

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

getJavaMethodName

public final String getJavaMethodName(Definition definition)

Description copied from interface: GeneratorStrategy

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

This is the same as calling getJavaMethodName(definition, Mode.DEFAULT)

Specified by:

getJavaMethodName in interface GeneratorStrategy

Returns:

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

getJavaClassExtends

public final String getJavaClassExtends(Definition definition)

Description copied from interface: GeneratorStrategy

This is the same as calling getJavaClassExtends(definition, Mode.DEFAULT)

Specified by:

getJavaClassExtends in interface GeneratorStrategy

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 final List<String> getJavaClassImplements(Definition definition)

Description copied from interface: GeneratorStrategy

This is the same as calling getJavaClassImplements(definition, Mode.DEFAULT)

Specified by:

getJavaClassImplements in interface GeneratorStrategy

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 final String getJavaClassName(Definition definition)

Description copied from interface: GeneratorStrategy

This is the same as calling getJavaClassName(definition, Mode.DEFAULT)

Specified by:

getJavaClassName in interface GeneratorStrategy

Returns:

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

getJavaPackageName

public final String getJavaPackageName(Definition definition)

Description copied from interface: GeneratorStrategy

This is the same as calling getJavaPackageName(definition, Mode.DEFAULT)

Specified by:

getJavaPackageName in interface GeneratorStrategy

Returns:

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

getJavaMemberName

public final String getJavaMemberName(Definition definition)

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

This is the same as calling getJavaMemberName(definition, Mode.DEFAULT)

Specified by:

getJavaMemberName in interface GeneratorStrategy

Returns:

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

getGlobalReferencesFullJavaClassName

public final String getGlobalReferencesFullJavaClassName(Definition container,
                                                         Class<? extends Definition> objectType)

Specified by:

getGlobalReferencesFullJavaClassName in interface GeneratorStrategy

Returns:

The full Java class name of the global references class for a given definition type, e.g. [org.jooq.generated.MyTable]

getFullJavaClassName

public final String getFullJavaClassName(Definition definition)

Specified by:

getFullJavaClassName in interface GeneratorStrategy

Returns:

The full Java class name representing this object, e.g. [org.jooq.generated.MyTable]

getFullJavaClassName

public final String getFullJavaClassName(Definition definition,
                                         GeneratorStrategy.Mode mode)

Description copied from interface: GeneratorStrategy

This is the same as calling getFullJavaClassName(definition, Mode.DEFAULT)

Specified by:

getFullJavaClassName in interface GeneratorStrategy

Returns:

The full Java class name representing this object, e.g. [org.jooq.generated.MyTable][suffix]

getJavaEnumLiterals

public final List<String> getJavaEnumLiterals(EnumDefinition definition,
                                              Collection<? extends String> literals)

Specified by:

getJavaEnumLiterals in interface GeneratorStrategy

See Also:

GeneratorStrategy.getJavaEnumLiteral(EnumDefinition, String)

getJavaEnumLiterals

public final List<String> getJavaEnumLiterals(EnumDefinition definition,
                                              String... literals)

Specified by:

getJavaEnumLiterals in interface GeneratorStrategy

See Also:

GeneratorStrategy.getJavaEnumLiteral(EnumDefinition, String)

getJavaIdentifiers

public final List<String> getJavaIdentifiers(Collection<? extends Definition> definitions)

Specified by:

getJavaIdentifiers in interface GeneratorStrategy

See Also:

GeneratorStrategy.getJavaIdentifier(Definition)

getJavaIdentifiers

public final List<String> getJavaIdentifiers(Definition... definitions)

Specified by:

getJavaIdentifiers in interface GeneratorStrategy

See Also:

GeneratorStrategy.getJavaIdentifier(Definition)

getFullJavaIdentifiers

public final List<String> getFullJavaIdentifiers(Collection<? extends Definition> definitions)

Specified by:

getFullJavaIdentifiers in interface GeneratorStrategy

See Also:

GeneratorStrategy.getFullJavaIdentifier(Definition)

getFullJavaIdentifiers

public final List<String> getFullJavaIdentifiers(Definition... definitions)

Specified by:

getFullJavaIdentifiers in interface GeneratorStrategy

See Also:

GeneratorStrategy.getFullJavaIdentifier(Definition)