com.datawizards.dmg.annotations.package.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of data-model-generator_2.11 Show documentation

data-model-generator

The newest version!

package com.datawizards.dmg

import com.datawizards.dmg.dialects.Dialect

import scala.annotation.StaticAnnotation

package object annotations {

  /**
    * @param name custom table name
    * @param dialect if provided then custom name only for this dialect
    */
  final class table(val name: String, val dialect: Dialect) extends StaticAnnotation {
    def this(name: String) = this(name, null)
  }

  /**
    * @param name custom column name
    * @param dialect if provided then custom name only for this dialect
    */
  final class column(val name: String, val dialect: Dialect) extends StaticAnnotation {
    def this(name: String) = this(name, null)
  }

  /**
    * @param value documentation comment
    */
  final class comment(val value: String, val dialect: Dialect) extends StaticAnnotation {
    def this(value: String) = this(value, null)
  }

  /**
    * @param value column length
    */
  final class length(val value: Int, val dialect: Dialect) extends StaticAnnotation {
    def this(value: Int) = this(value, null)
  }

  /**
    * Not null field
    */
  final class notNull(val dialect: Dialect) extends StaticAnnotation {
    def this() = this(null)
  }

  /**
    * Convert table name and column names to underscore.
    *
    * Example: personName -> person_name
    *
    * @param dialect Dialect for which make conversion
    */
  final class underscore(val dialect: Dialect) extends StaticAnnotation {
    def this() = this(null)
  }
}