org.allenai.common

Enum

Related Doc: package common

abstract class Enum[E <: Enum[E]] extends AnyRef

Enumeration implementation that supports automatic Spray JSON serialization as JsString(id).

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Enum
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Enum(id: String)

    id

    value used for lookup and JSON serialization

    Usage: (format: OFF)

    sealed abstract class MyEnum(id: String) extends Enum[MyEnum](id)
    object MyEnum extends EnumCompanion[MyEnum] {
      case object One extends MyEnum("one")
      case object Two extends MyEnum("two")
      register(One, Two)
    }
    
    // JSON serialization:
    MyEnum.One.toJson // JsString("one")
    MyEnum.Two.toJson // JsString("two")
    JsString("one").convertTo[MyEnum] // MyEnum.One
    JsString("two").convertTo[MyEnum] // MyEnum.Two

    (format: ON)

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
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  11. val id: String

    value used for lookup and JSON serialization

    value used for lookup and JSON serialization

    Usage: (format: OFF)

    sealed abstract class MyEnum(id: String) extends Enum[MyEnum](id)
    object MyEnum extends EnumCompanion[MyEnum] {
      case object One extends MyEnum("one")
      case object Two extends MyEnum("two")
      register(One, Two)
    }
    
    // JSON serialization:
    MyEnum.One.toJson // JsString("one")
    MyEnum.Two.toJson // JsString("two")
    JsString("one").convertTo[MyEnum] // MyEnum.One
    JsString("two").convertTo[MyEnum] // MyEnum.Two

    (format: ON)

  12. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  14. final def notify(): Unit

    Definition Classes
    AnyRef
  15. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  16. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  17. def toString(): String

    Definition Classes
    Enum → AnyRef → Any
  18. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped