Packages

c

slick.codegen

AbstractSourceCodeGenerator

abstract class AbstractSourceCodeGenerator extends AbstractGenerator[String, String, String] with StringGeneratorHelpers

Base implementation for a Source code String generator

Source
AbstractSourceCodeGenerator.scala
Linear Supertypes
StringGeneratorHelpers, AbstractGenerator[String, String, String], GeneratorHelpers[String, String, String], AnyRef, Any
Known Subclasses
SourceCodeGenerator
Type Hierarchy
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. AbstractSourceCodeGenerator
  2. StringGeneratorHelpers
  3. AbstractGenerator
  4. GeneratorHelpers
  5. AnyRef
  6. Any
Implicitly
  1. by StringFormat
  2. by Ensuring
  3. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new AbstractSourceCodeGenerator(model: Model)

Type Members

  1. abstract case class AbstractTableDef(model: model.Table) extends Product with Serializable

    Code generator for table related code

    Code generator for table related code

    model

    corresponding Slick meta model component

    Definition Classes
    AbstractGenerator
  2. abstract class AbstractSourceCodeTableDef extends AbstractTableDef
  3. abstract type Table <: AbstractTableDef

    Table generator virtual class

    Table generator virtual class

    Definition Classes
    AbstractGenerator
  4. implicit class StringExtensions extends AnyRef

    Slick code generator string extension methods.

    Slick code generator string extension methods. (Warning: Not unicode-safe, uses String#apply)

    Definition Classes
    GeneratorHelpers

Abstract Value Members

  1. abstract def Table: (model.Table) => Table

    Table generator factory.

    Table generator factory. Override for customization.

    Definition Classes
    AbstractGenerator

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def ->[B](y: B): (AbstractSourceCodeGenerator, B)
    Implicit
    This member is added by an implicit conversion from AbstractSourceCodeGenerator toArrowAssoc[AbstractSourceCodeGenerator] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  7. def code: String

    Generates code for the complete model (not wrapped in a package yet)

  8. def codeForContainer: String

    Generates code for the container class (not wrapped in a package yet)

  9. def codeForDDL: String

    Generates code for the DDL statement.

  10. def codePerTable: Map[String, String]

    Generates a map that associates the table name with its generated code (not wrapped in a package yet).

  11. val ddlEnabled: Boolean

    Enables DDL Generation.

    Enables DDL Generation.

    Definition Classes
    AbstractGenerator
  12. def docWithCode(doc: String, code: String): String

    Assemble doc comment with scala code

    Assemble doc comment with scala code

    Definition Classes
    StringGeneratorHelpers → GeneratorHelpers
  13. def ensuring(cond: (AbstractSourceCodeGenerator) => Boolean, msg: => Any): AbstractSourceCodeGenerator
    Implicit
    This member is added by an implicit conversion from AbstractSourceCodeGenerator toEnsuring[AbstractSourceCodeGenerator] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: (AbstractSourceCodeGenerator) => Boolean): AbstractSourceCodeGenerator
    Implicit
    This member is added by an implicit conversion from AbstractSourceCodeGenerator toEnsuring[AbstractSourceCodeGenerator] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean, msg: => Any): AbstractSourceCodeGenerator
    Implicit
    This member is added by an implicit conversion from AbstractSourceCodeGenerator toEnsuring[AbstractSourceCodeGenerator] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean): AbstractSourceCodeGenerator
    Implicit
    This member is added by an implicit conversion from AbstractSourceCodeGenerator toEnsuring[AbstractSourceCodeGenerator] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def entityName: (String) => String

    Maps database table name to entity case class name

    Maps database table name to entity case class name

    Definition Classes
    AbstractGenerator
  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  20. def foreignKeysPerTable: Map[String, List[String]]
  21. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  22. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  23. def indent(code: String): String
    Definition Classes
    GeneratorHelpers
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  28. final def optionType(t: String): String

    Wrap the given type into an Option type

    Wrap the given type into an Option type

    Definition Classes
    StringGeneratorHelpers → GeneratorHelpers
  29. def parseType(tpe: String): String

    Generates code for a qualified Scala type

    Generates code for a qualified Scala type

    Definition Classes
    StringGeneratorHelpers → GeneratorHelpers
  30. val scalaKeywords: Seq[String]

    Words that are reserved keywords in Scala

    Words that are reserved keywords in Scala

    Definition Classes
    GeneratorHelpers
  31. def shouldQuoteIdentifier(s: String): Boolean
    Definition Classes
    StringGeneratorHelpers
  32. val slickTableTermMembersNoArgs: Seq[String]

    Existing term member names in Table[_] that do not take parameters

    Existing term member names in Table[_] that do not take parameters

    Definition Classes
    GeneratorHelpers
  33. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  34. def tableName: (String) => String

    Maps database table name to Table class and value name

    Maps database table name to Table class and value name

    Definition Classes
    AbstractGenerator
  35. final lazy val tables: Seq[Table]

    Table code generators.

    Table code generators.

    Definition Classes
    AbstractGenerator
  36. final lazy val tablesByName: Map[QualifiedName, Table]

    Table code generators indexed by db table name.

    Table code generators indexed by db table name.

    Definition Classes
    AbstractGenerator
  37. def termName(name: String): String

    Marks a String as a TermName (e.g.

    Marks a String as a TermName (e.g. for escaping scala keywords)

    Definition Classes
    StringGeneratorHelpers → GeneratorHelpers
  38. def toString(): String
    Definition Classes
    AnyRef → Any
  39. def tuple(i: Int): String
    Attributes
    protected
  40. def typeName(name: String): String

    Marks a String as a TypeName (e.g.

    Marks a String as a TypeName (e.g. for escaping scala keywords)

    Definition Classes
    StringGeneratorHelpers → GeneratorHelpers
  41. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  42. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  43. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

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

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from AbstractSourceCodeGenerator toStringFormat[AbstractSourceCodeGenerator] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def →[B](y: B): (AbstractSourceCodeGenerator, B)
    Implicit
    This member is added by an implicit conversion from AbstractSourceCodeGenerator toArrowAssoc[AbstractSourceCodeGenerator] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from StringGeneratorHelpers

Inherited from AbstractGenerator[String, String, String]

Inherited from GeneratorHelpers[String, String, String]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion StringFormat fromAbstractSourceCodeGenerator to StringFormat[AbstractSourceCodeGenerator]

Inherited by implicit conversion Ensuring fromAbstractSourceCodeGenerator to Ensuring[AbstractSourceCodeGenerator]

Inherited by implicit conversion ArrowAssoc fromAbstractSourceCodeGenerator to ArrowAssoc[AbstractSourceCodeGenerator]

Basic customization overrides

Ungrouped