Packages

t

app.wordpace.inkwell

GeneratorConfiguration

trait GeneratorConfiguration extends AnyRef

Basic and advanced configuration options that can be modified without extending the generator class.

In most cases, extend DefaultGeneratorConfiguration instead of this trait directly.

Linear Supertypes
AnyRef, Any
Known Subclasses
DefaultGeneratorConfiguration
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GeneratorConfiguration
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def basePackage: String

    The base package of all compilation units, which is basically concatenated with each unit's name.

  2. abstract def companionEmitter: CompanionEmitter

    The companion emitter generates companion object code for a given Model.

  3. abstract def createModel(table: Table): Model

    Creates a model from the given table.

    Creates a model from the given table. The model's CompilationUnit must be linked by SchemaSlicer.

  4. abstract def createProperty(column: Column, model: Model): Property

    Crates a property from the given column as part of the given model.

  5. abstract def db: DatabaseConfiguration

    The DatabaseConfiguration used to access your local database.

  6. abstract def ignoredTables: Set[String]

    Names of all tables that should be ignored during code generation.

  7. abstract def imports: Set[Import]

    A set of imported classes and packages which will be accessible by simple name in the generated code.

  8. abstract def modelEmitter: ModelEmitter

    The model emitter generates case class code for a given Model.

  9. abstract def namingStrategy: NamingStrategy

    The naming strategy turns SQL names into Scala names for tables and columns (classes and attributes).

    The naming strategy turns SQL names into Scala names for tables and columns (classes and attributes). You can use one of the provided naming strategies or implement your own.

  10. abstract def propertyEmitter: PropertyEmitter

    The property emitter generates property code for a given Property.

  11. abstract def scalafmtConfig: Option[Path]

    A Path to your scalafmt configuration file or None if no code formatting is desired.

  12. abstract def schemaReader: SchemaReader

    The schema reader fetches the schema from the database and transforms it into a schema model.

    The schema reader fetches the schema from the database and transforms it into a schema model. You generally don't need to override this, but the option is there just in case.

  13. abstract def schemaSlicer: SchemaSlicer

    The schema slicer slices the schema into a set of CompilationUnit.

  14. abstract def sourceSchema: String

    The name of the schema used as the basis for code generation.

  15. abstract def targetFolder: Path

    The target folder where the root folder of the base package will be placed.

    The target folder where the root folder of the base package will be placed.

    For example, assume the base package is com.example, we have one compilation unit with a name schema.Schema, and the target folder is target/scala-2.12/src_managed. Generator will write the compilation unit to the file target/scala-2.12/src_managed/com/example/schema/Schema.scala.

  16. abstract def typeEmitter: TypeEmitter

    The type emitter can be overridden to change how types, type names and/or column types are emitted.

  17. abstract def typeResolver: TypeResolver

    The type resolver translates JDBC types to Scala types.

  18. abstract def unitEmitter: CompilationUnitEmitter

    The unit emitter generates the code for a whole CompilationUnit.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate() @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from AnyRef

Inherited from Any

Ungrouped