com.pagerduty.mapper.annotations.package.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of entity-mapper_2.11 Show documentation
entity-mapper
The newest version!
/*
 * Copyright (c) 2015, PagerDuty
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are permitted
 * provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this list of conditions
 * and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice, this list of
 * conditions and the following disclaimer in the documentation and/or other materials provided with
 * the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its contributors may be used to
 * endorse or promote products derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
 * WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package com.pagerduty.mapper

import com.pagerduty.mapper.annotations.impl._
import scala.annotation.meta.field


package object annotations {

  /**
   * Used to annotate persistable classes.
   * {{{
   * @Entity
   * case class MyClass(...)
   * }}}
   */
  type Entity = EntityAnnotation

  /**
   * Used to annotate the root of persistable class tree. All the persistable subclasses must
   * be defined in the annotation.
   * {{{
   * @Entity
   * @Superclass(Array(classOf[SubClass1], classOf[SubClass2]))
   * case class SuperClass(...)
   * }}}
   */
  type Superclass = SuperclassAnnotation

  /**
   * Used to define discriminator value for persistable classes that are part of inheritance
   * mapping.
   * {{{
   * @Entity
   * @Discriminator("subclass1")
   * case class SubClass1(...)
   * }}}
   */
  type Discriminator = DiscriminatorAnnotation

  /**
   * Used to define TTL in seconds. When combined with inheritance mapping, and both superclass and
   * a subclass specify TTL, the most specific TTL (the subclass) will take precedence.
   *
   * If a class has fields that themselves are annotate as @Entity and specify a @Ttl, those other
   * TTL values are ignored. All the fields in a class will have the same TTL value as specified
   * with Entity that maps to a column family. If the outermost Entity does not specify a TTL,
   * then none of the fields will have TTL set.
   *
   * {{{
   * @Entity
   * @Ttl(seconds=2*3600)
   * case class MyClass(...)
   * }}}
   */
  type Ttl = TtlAnnotation

  /**
   * Used to annotate id field in an @Entity.
   */
  type Id = IdAnnotation @field

  /**
   * Used to annotate field in an @Entity.
   */
  type Column = ColumnAnnotation @field

  /**
   * Used on fields in conjunction with @Column to indicate special serializer.
   */
  type Serializer = SerializerAnnotation @field
}