Packages

class ColumnDef extends TableDef.ColumnDef

Source
AbstractSourceCodeGenerator.scala
Linear Supertypes
TableDef.ColumnDef, Serializable, Product, Equals, TableDef.TermDef, TableDef.Def, AnyRef, Any
Type Hierarchy
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. ColumnDef
  2. ColumnDef
  3. Serializable
  4. Product
  5. Equals
  6. TermDef
  7. Def
  8. AnyRef
  9. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ColumnDef(model: model.Column)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from ColumnDef toany2stringadd[ColumnDef] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ColumnDef, B)
    Implicit
    This member is added by an implicit conversion from ColumnDef toArrowAssoc[ColumnDef] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def actualType: String

    Possibly Option-wrapped Scala type of this column.

    Possibly Option-wrapped Scala type of this column. @see rawType and @see exposedType

    Definition Classes
    ColumnDef
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def asOption: Boolean

    Indicates whether the exposed type of this column should be wrapped in an Option.

    Indicates whether the exposed type of this column should be wrapped in an Option. Useful for autoInc and automatically created columns. Set to autoInc to expose autoInc columns as Option.

    Definition Classes
    ColumnDef
  9. final def autoInc: Boolean

    Indicates whether this is an auto increment column

    Indicates whether this is an auto increment column

    Definition Classes
    ColumnDef
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  11. def code: String

    Scala code

    Scala code

    Definition Classes
    ColumnDefDef
  12. def columnOptionCode: (ColumnOption[_]) => Option[String]

    Generates code for a columnOption

    Generates code for a columnOption

    Definition Classes
    ColumnDefColumnDef
  13. def dbType: Boolean

    Indicates if a (non-portable) DBType ColumnOption should be generated

    Indicates if a (non-portable) DBType ColumnOption should be generated

    Definition Classes
    ColumnDef
  14. def default: Option[String]

    Generates a literal represenation of the default value or None in case of an Option-typed autoinc column

    Generates a literal represenation of the default value or None in case of an Option-typed autoinc column

    Definition Classes
    ColumnDef
  15. def defaultCode: (Any) => String

    Returns a function, that maps a value to its literal representation as code

    Returns a function, that maps a value to its literal representation as code

    Definition Classes
    ColumnDefColumnDef
  16. def disambiguateTerm(name: String, postfix: String = "X"): String

    Adds one or more X to the end of the given string to avoid collisions with column names.

    Adds one or more X to the end of the given string to avoid collisions with column names.

    Definition Classes
    TermDef
  17. def doc: String

    Scala doc comment

    Scala doc comment

    Definition Classes
    ColumnDefDef
  18. def docWithCode: String

    Scala doc comment with code

    Scala doc comment with code

    Definition Classes
    TermDefDef
  19. def enabled: Boolean

    Indicates whether this will be included in the generated code

    Indicates whether this will be included in the generated code

    Definition Classes
    Def
  20. def ensuring(cond: (ColumnDef) => Boolean, msg: => Any): ColumnDef
    Implicit
    This member is added by an implicit conversion from ColumnDef toEnsuring[ColumnDef] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  21. def ensuring(cond: (ColumnDef) => Boolean): ColumnDef
    Implicit
    This member is added by an implicit conversion from ColumnDef toEnsuring[ColumnDef] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  22. def ensuring(cond: Boolean, msg: => Any): ColumnDef
    Implicit
    This member is added by an implicit conversion from ColumnDef toEnsuring[ColumnDef] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  23. def ensuring(cond: Boolean): ColumnDef
    Implicit
    This member is added by an implicit conversion from ColumnDef toEnsuring[ColumnDef] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  24. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. final def exposedType: String

    Option of actualType if fakeNullable else actualType.

    Option of actualType if fakeNullable else actualType.

    Definition Classes
    ColumnDef
  26. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  27. final def getEnabled: Option[TableDef.Def]

    Returns Some(this) if enabled else None

    Returns Some(this) if enabled else None

    Definition Classes
    Def
  28. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  29. val model: model.Column
    Definition Classes
    ColumnDef
  30. final def name: String

    Name (escaped if colliding with Scala keyword).

    Name (escaped if colliding with Scala keyword).

    Definition Classes
    TermDef
  31. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  32. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  33. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  34. def options: Iterable[String]

    Generates code for the ColumnOptions (DBType, AutoInc, etc.)

    Generates code for the ColumnOptions (DBType, AutoInc, etc.)

    Definition Classes
    ColumnDef
  35. def productElementNames: Iterator[String]
    Definition Classes
    Product
  36. def rawName: String

    Name as desired in Scala Code.

    Name as desired in Scala Code. (Allowed to collide with Scala keywords. Will be automatically escaped.)

    Definition Classes
    ColumnDefDef
  37. def rawType: String

    Underlying Scala type of this column.

    Underlying Scala type of this column. Override this to just affect the data type but preserve potential Option-wrapping.

    Definition Classes
    ColumnDef
  38. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  39. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  40. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  41. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. final def fakeNullable: Boolean

    Indicates whether this column should be user facing as a nullable column with default None even though it is not.

    Indicates whether this column should be user facing as a nullable column with default None even though it is not. Useful for autoInc columns.

    Definition Classes
    ColumnDef
    Annotations
    @deprecated
    Deprecated

    (Since version 3.2.0) Use asOption instead.

  2. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated
  3. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ColumnDef toStringFormat[ColumnDef] 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.

  4. def [B](y: B): (ColumnDef, B)
    Implicit
    This member is added by an implicit conversion from ColumnDef toArrowAssoc[ColumnDef] 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 TableDef.ColumnDef

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from TableDef.TermDef

Inherited from TableDef.Def

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromColumnDef to any2stringadd[ColumnDef]

Inherited by implicit conversion StringFormat fromColumnDef to StringFormat[ColumnDef]

Inherited by implicit conversion Ensuring fromColumnDef to Ensuring[ColumnDef]

Inherited by implicit conversion ArrowAssoc fromColumnDef to ArrowAssoc[ColumnDef]

Basic customization overrides

Ungrouped