io.scalaland.enumz.Enum.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of enumz_3 Show documentation

Common type class interface for various enums implementations

The newest version!

package io.scalaland.enumz

import scala.language.dynamics

@SuppressWarnings(Array("org.wartremover.warts.Equals", "org.wartremover.warts.OptionPartial"))
trait Enum[E] extends Dynamic {

  def values: Vector[E]
  lazy val indices: Map[E, Int] = values.zipWithIndex.toMap

  def getName(`enum`: E): String
  def getIndex(`enum`: E): Int = indices(`enum`)

  def withIndexOption(index: Int): Option[E] = values.lift(index)
  def withIndex(index: Int): E = withIndexOption(index).get

  def withNameOption(name: String): Option[E] = values.find(getName(_) == name)
  def withName(name: String): E = withNameOption(name).get

  def withNameInsensitiveOption(name: String): Option[E] = values.find(getName(_) equalsIgnoreCase name)
  def withNameInsensitive(name: String): E = withNameInsensitiveOption(name).get

  def selectDynamic(name: String): E = withName(name)
}

object Enum extends Implicits0 {

  def apply[E](implicit `enum`: Enum[E]): Enum[E] = `enum`
}

private[enumz] trait Implicits0 extends JavaEnumImplicits with Implicits1
private[enumz] trait Implicits1 extends EnumerationImplicits with Implicits2
private[enumz] trait Implicits2 extends EnumeratumImplicits with Implicits3
private[enumz] trait Implicits3 extends SumTypeEnumImplicits