Trait/Object

fm.common

ByteEnum

Related Docs: object ByteEnum | package common

Permalink

trait ByteEnum[A <: ByteEnumEntry] extends ValueEnum[Byte, A]

Value enum with ByteEnumEntry entries

This is similar to enumeratum.Enum, but different in that values must be literal values. This restraint allows us to enforce uniqueness at compile time.

Note that uniqueness is only guaranteed if you do not do any runtime string manipulation on values.

Linear Supertypes
ValueEnum[Byte, A], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ByteEnum
  2. ValueEnum
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def values: IndexedSeq[A]

    Permalink

    The sequence of values for your Enum.

    The sequence of values for your Enum. You will typically want to implement this in your extending class as a val so that withValue and friends are as efficient as possible.

    Feel free to implement this however you'd like (including messing around with ordering, etc) if that fits your needs better.

    Definition Classes
    ValueEnum

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  9. final macro def findValues: IndexedSeq[A]

    Permalink

    Method that returns a Seq of A objects that the macro was able to find.

    Method that returns a Seq of A objects that the macro was able to find.

    You will want to use this in some way to implement your values method. In fact, if you aren't using this method...why are you even bothering with this lib?

    Attributes
    protected

  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  11. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  13. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  14. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  15. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    AnyRef

  17. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  18. final lazy val valuesToEntriesMap: Map[Byte, A]

    Permalink

    Map of ValueType to EntryType members

    Map of ValueType to EntryType members

    Definition Classes
    ValueEnum

  19. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  20. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  21. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  22. def withValue(i: Byte): A

    Permalink

    Tries to get an EntryType by the supplied value.

    Tries to get an EntryType by the supplied value. The value corresponds to the .value of the case objects implementing EntryType

    Like Enumeration's withValue, this method will throw if the value does not match any of the values' .value values.

    Definition Classes
    ValueEnum
    Annotations
    @SuppressWarnings()

  23. def withValueOpt(i: Byte): Option[A]

    Permalink

    Optionally returns an EntryType for a given value.

    Optionally returns an EntryType for a given value.

    Definition Classes
    ValueEnum

Inherited from ValueEnum[Byte, A]

Inherited from AnyRef

Inherited from Any

Ungrouped