Enumeratum

https://www.javadoc.io/doc/com.beachape/enumeratum_2.13/latest
Admin
Enumeratum is a Scala library for creating exhaustive pattern-matching friendly enumerations with...
Tokens:61,103
Snippets:190
Trust Score:9.5
Update:6 months ago
Show doc for...
Tokens:
Raw
### IntEnum Example

Source: https://www.javadoc.io/doc/com.beachape/enumeratum_2.13/latest/enumeratum/values/index.html

Example demonstrating how to define and use an IntEnum.

```APIDOC
## Example Usage of IntEnum

### Description
This example shows how to define a sealed abstract class `Greeting` that extends `IntEnumEntry` and an `IntEnum` object `Greeting` to manage these entries.

### Code Example
```scala
sealed abstract class Greeting(val value: Int) extends IntEnumEntry

object Greeting extends IntEnum[Greeting] {
  val values = findValues
  case object Hello   extends Greeting(1)
  case object GoodBye extends Greeting(2)
  case object Hi      extends Greeting(3)
  case object Bye     extends Greeting(4)
}
```

### Usage Example
```scala
// Assuming the above definition is in scope
Greeting.withValueOpt(1) // Returns: Some(Hello)
Greeting.withValueOpt(6) // Returns: None
```
```

--------------------------------

### IntEnum Example with Value Lookup

Source: https://www.javadoc.io/doc/com.beachape/enumeratum_2.13/latest/enumeratum/values/index.html

Demonstrates defining an IntEnum and using `withValueOpt` to retrieve an enum member by its integer value. Ensure values are unique for compile-time safety.

```scala
sealed abstract class Greeting(val value: Int) extends IntEnumEntry

object Greeting extends IntEnum[Greeting] {
  val values = findValues
  case object Hello   extends Greeting(1)
  case object GoodBye extends Greeting(2)
  case object Hi      extends Greeting(3)
  case object Bye     extends Greeting(4)
}

Greeting.withValueOpt(1)
Greeting.withValueOpt(6)
```

--------------------------------

### withValue

Source: https://www.javadoc.io/doc/com.beachape/enumeratum_2.13/latest/enumeratum/values/IntEnum.html

Tries to get an EntryType by the supplied integer value. Throws an exception if the value does not match any existing entries.

```APIDOC
## withValue

### Description
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.

### Method
def

### Endpoint
N/A (Method within a class)

### Parameters
- **i** (Int) - Required - The integer value to look for.

### Request Example
N/A

### Response
#### Success Response (200)
- **A**: The EntryType corresponding to the given value.

#### Error Response
- **Exception**: Thrown if no matching value is found.

### Response Example
```json
{
  "example": "EntryTypeInstance"
}
```
```

--------------------------------

### GET /value

Source: https://www.javadoc.io/doc/com.beachape/enumeratum_2.13/latest/enumeratum/values/ValueEnumEntry.html

Retrieves the value of the current entry.

```APIDOC
## GET /value

### Description
Retrieves the value of this entry.

### Method
GET

### Endpoint
/value

### Response
#### Success Response (200)
- **value** (ValueType) - The value associated with this entry.
```

--------------------------------

### Enum Trait Definition and Usage

Source: https://www.javadoc.io/doc/com.beachape/enumeratum_2.13/latest/enumeratum/Enum.html

Demonstrates how to define a custom enumeration using the enumeratum's Enum trait and its companion object. Includes an example of using `withNameOption` to retrieve enum values.

```APIDOC
## Enum Trait

### Description
The `Enum` trait from the enumeratum library provides a robust way to implement exhaustive enumerations in Scala. It allows for easy definition of enum values and provides utility methods for name-based lookups.

### Usage Example

```scala
import enumeratum._

sealed trait DummyEnum extends EnumEntry

object DummyEnum extends Enum[DummyEnum] {
  val values = findValues
  case object Hello   extends DummyEnum
  case object GoodBye extends DummyEnum
  case object Hi      extends DummyEnum
}

// Retrieving enum values by name
DummyEnum.withNameOption("Hello")
// Result: Some(Hello)

DummyEnum.withNameOption("Nope")
// Result: None
```

### Abstract Value Members

- **values** (IndexedSeq[A]) - Required - The sequence of values for your Enum. This should typically be implemented as a `val` for efficiency.
```

--------------------------------

### Define a Scala IntEnum using ValueEnum

Source: https://www.javadoc.io/doc/com.beachape/enumeratum_2.13/latest/enumeratum/values/ValueEnum.html

Example of defining an IntEnum for greetings. It shows how to extend IntEnumEntry and implement the findValues method. Use this when your enum entries have integer values.

```scala
sealed abstract class Greeting(val value: Int) extends IntEnumEntry

object Greeting extends IntEnum[Greeting] {
  val values = findValues
  case object Hello   extends Greeting(1)
  case object GoodBye extends Greeting(2)
  case object Hi      extends Greeting(3)
  case object Bye     extends Greeting(4)
}
```

--------------------------------

### Define and use a ValueEnum

Source: https://www.javadoc.io/doc/com.beachape/enumeratum_2.13/latest/enumeratum/values/index.html

Demonstrates defining an IntEnum and using withValueOpt to retrieve members by their associated value.

```scala
scala> sealed abstract class Greeting(val value: Int) extends IntEnumEntry

scala> object Greeting extends IntEnum[Greeting] {
    |   val values = findValues
    |   case object Hello   extends Greeting(1)
    |   case object GoodBye extends Greeting(2)
    |   case object Hi      extends Greeting(3)
    |   case object Bye     extends Greeting(4)
    | }

scala> Greeting.withValueOpt(1)
res0: Option[Greeting] = Some(Hello)

scala> Greeting.withValueOpt(6)
res1: Option[Greeting] = None
```

--------------------------------

### EnumEntryOps - Instance Constructors

Source: https://www.javadoc.io/doc/com.beachape/enumeratum_2.13/latest/enumeratum/EnumEntry%24%24EnumEntryOps.html

Details the available constructors for creating instances of EnumEntryOps.

```APIDOC
## EnumEntryOps - Instance Constructors

### Description
Details the available constructors for creating instances of EnumEntryOps.

### Instance Constructors
  1. __ new EnumEntryOps(enumEntry: A)

### Parameters
* **enumEntry** (A) - The enum entry to wrap.
```

--------------------------------

### Product Methods

Source: https://www.javadoc.io/doc/com.beachape/enumeratum_2.13/latest/enumeratum/NoSuchMember.html

Methods related to the `Product` trait, typically used for case classes to provide access to their elements.

```APIDOC
## def productElementNames: Iterator[String]

### Description
Returns an iterator over the names of the elements of this product.

### Method
GET

### Endpoint
N/A (Instance method)

### Parameters
None

### Request Example
None

### Response
- **Iterator[String]** - An iterator over the names of the product's elements.
```

--------------------------------

### Standard Object Methods

Source: https://www.javadoc.io/doc/com.beachape/enumeratum_2.13/latest/enumeratum/Enum.html

Details standard methods inherited from `AnyRef` and `Any`, such as equality checks, cloning, and class information.

```APIDOC
## Standard Object Methods

### Description
This section covers standard methods inherited from `AnyRef` and `Any`, including equality checks, cloning, and class information.

### Methods

#### `!=`
- **Description**: Tests whether two objects are not equal.
- **Parameters**:
  - `arg0` (Any) - The object to compare with.
- **Returns**: `Boolean` - `true` if the objects are not equal, `false` otherwise.

#### `##`
- **Description**: Returns a hash code value for the object.
- **Returns**: `Int` - The hash code value.

#### `==`
- **Description**: Tests whether two objects are equal.
- **Parameters**:
  - `arg0` (Any) - The object to compare with.
- **Returns**: `Boolean` - `true` if the objects are equal, `false` otherwise.

#### `asInstanceOf[T0]`
- **Description**: Casts the object to type `T0`.
- **Type Parameters**:
  - `T0` - The target type for the cast.
- **Returns**: `T0` - The object cast to type `T0`.

#### `clone()`
- **Description**: Creates and returns a copy of this object. Throws `CloneNotSupportedException` if the object cannot be cloned.
- **Annotations**:
  - `@throws(classOf[java.lang.CloneNotSupportedException])`
  - `@IntrinsicCandidate()`
  - `@native()`
- **Returns**: `AnyRef` - A clone of the object.

#### `eq`
- **Description**: Tests whether two object references refer to the same object.
- **Parameters**:
  - `arg0` (AnyRef) - The reference to compare with.
- **Returns**: `Boolean` - `true` if the references are the same, `false` otherwise.

#### `equals`
- **Description**: Compares this object with the specified object for equality.
- **Parameters**:
  - `arg0` (AnyRef) - The object to compare with.
- **Returns**: `Boolean` - `true` if the objects are equal, `false` otherwise.

#### `getClass`
- **Description**: Returns the runtime class of this object.
- **Annotations**:
  - `@IntrinsicCandidate()`
  - `@native()`
- **Returns**: `Class[_ <: AnyRef]` - The runtime class of the object.

#### `hashCode`
- **Description**: Returns a hash code value for the object. This method is native.
- **Annotations**:
  - `@IntrinsicCandidate()`
  - `@native()`
- **Returns**: `Int` - The hash code value.

#### `isInstanceOf[T0]`
- **Description**: Tests whether an object is an instance of a particular type.
- **Type Parameters**:
  - `T0` - The type to check against.
- **Returns**: `Boolean` - `true` if the object is an instance of `T0`, `false` otherwise.

#### `ne`
- **Description**: Tests whether two object references do not refer to the same object.
- **Parameters**:
  - `arg0` (AnyRef) - The reference to compare with.
- **Returns**: `Boolean` - `true` if the references are different, `false` otherwise.

#### `notify`
- **Description**: Wakes up a single thread that is waiting on this object's monitor.
- **Annotations**:
  - `@IntrinsicCandidate()`
  - `@native()`

#### `notifyAll`
- **Description**: Wakes up all threads that are waiting on this object's monitor.
- **Annotations**:
  - `@IntrinsicCandidate()`
  - `@native()`

#### `synchronized`
- **Description**: Executes the given block of code within a synchronized block, ensuring exclusive access to the object.
- **Type Parameters**:
  - `T0` - The return type of the block.
- **Parameters**:
  - `arg0` (=> T0) - The code block to execute.
- **Returns**: `T0` - The result of the code block.

#### `toString`
- **Description**: Returns a string representation of the object.
- **Returns**: `String` - A string representation of the object.

#### `wait`
- **Description**: Causes the current thread to wait until it is awakened by a call to `notify()` or `notifyAll()` on this object, or until a specified amount of time has elapsed.
- **Annotations**:
  - `@throws(classOf[java.lang.InterruptedException])`

#### `wait(arg0: Long)`
- **Description**: Causes the current thread to wait until it is awakened by a call to `notify()` or `notifyAll()` on this object, or until the specified number of milliseconds has elapsed.
- **Parameters**:
  - `arg0` (Long) - The maximum time to wait in milliseconds.
- **Annotations**:
  - `@throws(classOf[java.lang.InterruptedException])`

#### `wait(arg0: Long, arg1: Int)`
- **Description**: Causes the current thread to wait until it is awakened by a call to `notify()` or `notifyAll()` on this object, or until the specified number of milliseconds plus the specified number of nanoseconds has elapsed.
- **Parameters**:
  - `arg0` (Long) - The maximum time to wait in milliseconds.
  - `arg1` (Int) - The maximum time to wait in nanoseconds.
- **Annotations**:
  - `@throws(classOf[java.lang.InterruptedException])`
```

--------------------------------

### Enumeratum Enum Entry Methods

Source: https://www.javadoc.io/doc/com.beachape/enumeratum_2.13/latest/enumeratum/EnumEntry%24%24Hyphencase.html

This section details the methods available for Enumeratum enum entries, including standard methods inherited from AnyRef and Any, as well as the specific entryName method.

```APIDOC
## Value Members

### `!=`(arg0: Any): Boolean

**Description**: Checks for inequality.
**Method**: N/A (method signature)
**Definition Classes**: AnyRef → Any

### `##`: Int

**Description**: Returns a hash code.
**Method**: N/A (method signature)
**Definition Classes**: AnyRef → Any

### `==(arg0: Any): Boolean

**Description**: Checks for equality.
**Method**: N/A (method signature)
**Definition Classes**: AnyRef → Any

### `clone()`: AnyRef

**Description**: Creates a clone of the object. Protected method.
**Method**: N/A (method signature)
**Attributes**: protected[lang]
**Definition Classes**: AnyRef
**Annotations**: @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()

### `eq`(arg0: AnyRef): Boolean

**Description**: Checks for reference equality.
**Method**: N/A (method signature)
**Definition Classes**: AnyRef

### `equals`(arg0: AnyRef): Boolean

**Description**: Compares this object to the specified object.
**Method**: N/A (method signature)
**Definition Classes**: AnyRef → Any

### `getClass()`: Class[_ <: AnyRef]

**Description**: Returns the runtime class of this object.
**Method**: N/A (method signature)
**Definition Classes**: AnyRef → Any
**Annotations**: @IntrinsicCandidate() @native()

### `hashCode()`: Int

**Description**: Returns a hash code value for the object.
**Method**: N/A (method signature)
**Definition Classes**: AnyRef → Any
**Annotations**: @IntrinsicCandidate() @native()

### `ne`(arg0: AnyRef): Boolean

**Description**: Checks for reference inequality.
**Method**: N/A (method signature)
**Definition Classes**: AnyRef

### `notify()`: Unit

**Description**: Wakes up a single thread that is waiting on this object's monitor.
**Method**: N/A (method signature)
**Definition Classes**: AnyRef
**Annotations**: @IntrinsicCandidate() @native()

### `notifyAll()`: Unit

**Description**: Wakes up all threads that are waiting on this object's monitor.
**Method**: N/A (method signature)
**Definition Classes**: AnyRef
**Annotations**: @IntrinsicCandidate() @native()

### `synchronized[T0](arg0: => T0): T0

**Description**: Executes the given code block while holding this object's monitor.
**Method**: N/A (method signature)
**Definition Classes**: AnyRef

### `toString()`: String

**Description**: Returns a string representation of the object.
**Method**: N/A (method signature)
**Definition Classes**: AnyRef → Any

### `wait`(arg0: Long, arg1: Int): Unit

**Description**: Waits until execution is resumed, or an exception is thrown.
**Method**: N/A (method signature)
**Definition Classes**: AnyRef
**Annotations**: @throws(classOf[java.lang.InterruptedException])

### `wait`(arg0: Long): Unit

**Description**: Waits until execution is resumed, or an exception is thrown.
**Method**: N/A (method signature)
**Definition Classes**: AnyRef
**Annotations**: @throws(classOf[java.lang.InterruptedException])

### `wait()`: Unit

**Description**: Waits until execution is resumed, or an exception is thrown.
**Method**: N/A (method signature)
**Definition Classes**: AnyRef
**Annotations**: @throws(classOf[java.lang.InterruptedException])

### `finalize()`: Unit

**Description**: Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
**Method**: N/A (method signature)
**Attributes**: protected[lang]
**Definition Classes**: AnyRef
**Annotations**: @throws(classOf[java.lang.Throwable]) @Deprecated
**Deprecated**: Since version 9

### Inherited from Any

### `asInstanceOf[T0]`: T0

**Description**: Casts this object to be of type T0.
**Method**: N/A (method signature)
**Definition Classes**: Any

### `isInstanceOf[T0]`: Boolean

**Description**: Checks whether this object is an instance of T0.
**Method**: N/A (method signature)
**Definition Classes**: Any

### Ungrouped

### `entryName`: String

**Description**: String representation of this Enum Entry. Override in your implementation if needed.
**Method**: N/A (method signature)
**Definition Classes**: Lowercase → EnumEntry
```

--------------------------------

### Enumeratum EnumEntry Methods

Source: https://www.javadoc.io/doc/com.beachape/enumeratum_2.13/latest/enumeratum/EnumEntry%24%24CapitalWords.html

This section details the methods available for EnumEntry in the Enumeratum library, including inherited methods from AnyRef and Any, as well as specific methods like entryName.

```APIDOC
## Value Members

### `!=`(arg0: Any): Boolean

**Description**: Checks for inequality.

**Method**: Any

**Endpoint**: N/A

### `##`: Int

**Description**: Returns a hash code.

**Method**: Any

**Endpoint**: N/A

### `==(arg0: Any): Boolean

**Description**: Checks for equality.

**Method**: Any

**Endpoint**: N/A

### `clone()`: AnyRef

**Description**: Creates a clone of the object. Protected method.

**Method**: AnyRef

**Endpoint**: N/A

**Annotations**: @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()

### `eq`(arg0: AnyRef): Boolean

**Description**: Checks for reference equality.

**Method**: AnyRef

**Endpoint**: N/A

### `equals`(arg0: AnyRef): Boolean

**Description**: Compares objects for equality.

**Method**: AnyRef → Any

**Endpoint**: N/A

### `getClass()`: Class[_ <: AnyRef]

**Description**: Returns the runtime class of an object.

**Method**: AnyRef → Any

**Endpoint**: N/A

**Annotations**: @IntrinsicCandidate() @native()

### `hashCode()`: Int

**Description**: Returns the hash code of an object.

**Method**: AnyRef → Any

**Endpoint**: N/A

**Annotations**: @IntrinsicCandidate() @native()

### `ne`(arg0: AnyRef): Boolean

**Description**: Checks for reference inequality.

**Method**: AnyRef

**Endpoint**: N/A

### `notify()`: Unit

**Description**: Wakes up a single thread waiting on this object's monitor.

**Method**: AnyRef

**Endpoint**: N/A

**Annotations**: @IntrinsicCandidate() @native()

### `notifyAll()`: Unit

**Description**: Wakes up all threads waiting on this object's monitor.

**Method**: AnyRef

**Endpoint**: N/A

**Annotations**: @IntrinsicCandidate() @native()

### `synchronized[T0](arg0: => T0): T0

**Description**: Executes the given block of code synchronized on this object.

**Method**: AnyRef

**Endpoint**: N/A

### `toString()`: String

**Description**: Returns a string representation of the object.

**Method**: AnyRef → Any

**Endpoint**: N/A

### `wait`(arg0: Long, arg1: Int): Unit

**Description**: Causes the current thread to wait until the object is unlocked, a thread interrupts the current thread, or a specified amount of time has elapsed.

**Method**: AnyRef

**Endpoint**: N/A

**Annotations**: @throws(classOf[java.lang.InterruptedException])

### `wait`(arg0: Long): Unit

**Description**: Causes the current thread to wait until the object is unlocked, a thread interrupts the current thread, or approximately the specified number of milliseconds has elapsed.

**Method**: AnyRef

**Endpoint**: N/A

**Annotations**: @throws(classOf[java.lang.InterruptedException])

### `wait()`: Unit

**Description**: Causes the current thread to wait until the object is unlocked or the thread is interrupted.

**Method**: AnyRef

**Endpoint**: N/A

**Annotations**: @throws(classOf[java.lang.InterruptedException])

### `finalize()`: Unit

**Description**: Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

**Method**: AnyRef

**Endpoint**: N/A

**Annotations**: @throws(classOf[java.lang.Throwable]) @Deprecated

**Deprecated**: Since version 9

### `asInstanceOf[T0]`: T0

**Description**: Casts the object to be of type T0.

**Method**: Any

**Endpoint**: N/A

### `isInstanceOf[T0]`: Boolean

**Description**: Checks whether the object is an instance of type T0.

**Method**: Any

**Endpoint**: N/A

### `entryName`: String

**Description**: String representation of this Enum Entry. Override in your implementation if needed.

**Method**: CapitalWords → EnumEntry

**Endpoint**: N/A
```

--------------------------------

### EnumCompat Methods

Source: https://www.javadoc.io/doc/com.beachape/enumeratum_2.13/latest/enumeratum/Enum.html

This section covers methods related to retrieving and mapping enum values.

```APIDOC
## GET /api/enum/values

### Description
Retrieves the sequence of all values for the Enum.

### Method
GET

### Endpoint
/api/enum/values

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **values** (IndexedSeq[A]) - The sequence of enum values.

#### Response Example
```json
{
  "values": [
    "Value1",
    "Value2"
  ]
}
```

## GET /api/enum/extraNamesToValuesMap

### Description
Retrieves a map of additional names that can be mapped to enum values, useful for legacy values.

### Method
GET

### Endpoint
/api/enum/extraNamesToValuesMap

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **extraNamesToValuesMap** (Map[String, A]) - A map where keys are additional names and values are the corresponding enum members.

#### Response Example
```json
{
  "extraNamesToValuesMap": {
    "legacyName1": "Value1",
    "legacyName2": "Value2"
  }
}
```

## GET /api/enum/findValues

### Description
Returns a sequence of enum values that the macro was able to find. This is typically used to implement the `values` method.

### Method
GET

### Endpoint
/api/enum/findValues

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **findValues** (IndexedSeq[A]) - The sequence of enum values found by the macro.

#### Response Example
```json
{
  "findValues": [
    "Value1",
    "Value2"
  ]
}
```

## GET /api/enum/indexOf/{member}

### Description
Returns the index of a given enum member within the sequence of values.

### Method
GET

### Endpoint
/api/enum/indexOf/{member}

### Parameters
#### Path Parameters
- **member** (A) - Required - The enum member to find the index of.

### Request Example
None

### Response
#### Success Response (200)
- **indexOf** (Int) - The index of the member, or -1 if not found.

#### Response Example
```json
{
  "indexOf": 0
}
```

## GET /api/enum/withName/{name}

### Description
Tries to get an enum member by its name. Throws an exception if the name does not match any value's entryName.

### Method
GET

### Endpoint
/api/enum/withName/{name}

### Parameters
#### Path Parameters
- **name** (String) - Required - The name of the enum member to retrieve.

### Request Example
None

### Response
#### Success Response (200)
- **withName** (A) - The enum member corresponding to the provided name.

#### Response Example
```json
{
  "withName": "Value1"
}
```

## GET /api/enum/withNameEither/{name}

### Description
Returns an `Either[NoSuchMember[A], A]` for a given name. Returns `Right[A]` if found, `Left[NoSuchMember[A]]` otherwise.

### Method
GET

### Endpoint
/api/enum/withNameEither/{name}

### Parameters
#### Path Parameters
- **name** (String) - Required - The name of the enum member to retrieve.

### Request Example
None

### Response
#### Success Response (200)
- **withNameEither** (Either[NoSuchMember[A], A]) - Either a NoSuchMember exception or the found enum member.

#### Response Example
```json
{
  "withNameEither": {
    "status": "right",
    "value": "Value1"
  }
}
```

## GET /api/enum/withNameInsensitive/{name}

### Description
Tries to get an enum member by its name, ignoring case. Throws an exception if the name does not match any value's entryName.

### Method
GET

### Endpoint
/api/enum/withNameInsensitive/{name}

### Parameters
#### Path Parameters
- **name** (String) - Required - The name of the enum member to retrieve (case-insensitive).

### Request Example
None

### Response
#### Success Response (200)
- **withNameInsensitive** (A) - The enum member corresponding to the provided name (case-insensitive).

#### Response Example
```json
{
  "withNameInsensitive": "Value1"
}
```

## GET /api/enum/withNameInsensitiveEither/{name}

### Description
Returns an `Either[NoSuchMember[A], A]` for a given name, ignoring case. Returns `Right[A]` if found, `Left[NoSuchMember[A]]` otherwise.

### Method
GET

### Endpoint
/api/enum/withNameInsensitiveEither/{name}

### Parameters
#### Path Parameters
- **name** (String) - Required - The name of the enum member to retrieve (case-insensitive).

### Request Example
None

### Response
#### Success Response (200)
- **withNameInsensitiveEither** (Either[NoSuchMember[A], A]) - Either a NoSuchMember exception or the found enum member (case-insensitive).

#### Response Example
```json
{
  "withNameInsensitiveEither": {
    "status": "right",
    "value": "Value1"
  }
}
```
```

--------------------------------

### Inherited from Any

Source: https://www.javadoc.io/doc/com.beachape/enumeratum_2.13/latest/enumeratum/Enum%24.html

Methods inherited from the Any trait.

```APIDOC
## Inherited from Any

### Value Members

### `asInstanceOf[T0]: T0`

**Description**: Casts this object to be the specified type.

**Method**: final def

**Endpoint**: N/A

### `isInstanceOf[T0]: Boolean`

**Description**: Checks whether the object is an instance of a particular type.

**Method**: final def

**Endpoint**: N/A
```

--------------------------------

### Inherited from Any

Source: https://www.javadoc.io/doc/com.beachape/enumeratum_2.13/latest/enumeratum/EnumEntry%24%24LowerCamelcase.html

Methods inherited from the Any trait.

```APIDOC
## Inherited from Any

### `asInstanceOf[T0]: T0`

- **Description**: Casts the object to be of type T0.
- **Method**: N/A (method signature)
- **Endpoint**: N/A

### `isInstanceOf[T0]: Boolean`

- **Description**: Checks if the object is an instance of type T0.
- **Method**: N/A (method signature)
- **Endpoint**: N/A
```

--------------------------------

### withValueOpt

Source: https://www.javadoc.io/doc/com.beachape/enumeratum_2.13/latest/enumeratum/values/IntEnum.html

Optionally returns an EntryType for a given value.

```APIDOC
## withValueOpt

### Description
Optionally returns an EntryType for a given value.

### Method
def

### Endpoint
N/A (Method within a class)

### Parameters
- **i** (Int) - Required - The integer value to look for.

### Request Example
N/A

### Response
#### Success Response (200)
- **Option[A]**: An Option containing the EntryType if found, otherwise None.

### Response Example
```json
{
  "example": "Some(EntryTypeInstance)"
}
```
```json
{
  "example": "None"
}
```
```

--------------------------------

### Enumeratum Core Methods

Source: https://www.javadoc.io/doc/com.beachape/enumeratum_2.13/latest/enumeratum/NoSuchMember.html

This section details the core methods available in the Enumeratum library, including methods for accessing enum values and their properties.

```APIDOC
## val enumValues: IndexedSeq[A]

### Description
Retrieves all the enumerated values as an indexed sequence.

### Method
GET

### Endpoint
N/A (Instance method)

### Parameters
None

### Request Example
None

### Response
- **enumValues** (IndexedSeq[A]) - An indexed sequence containing all enumerated values.
```

```APIDOC
## val notFoundName: String

### Description
Represents the name or identifier used when an enumerated value is not found.

### Method
GET

### Endpoint
N/A (Instance method)

### Parameters
None

### Request Example
None

### Response
- **notFoundName** (String) - The identifier for a not-found enumerated value.
```

--------------------------------

### Inherited from Any

Source: https://www.javadoc.io/doc/com.beachape/enumeratum_2.13/latest/enumeratum/EnumEntry%24.html

Details of value members inherited from the Any class.

```APIDOC
## Inherited from Any

### Value Members

### `asInstanceOf[T0]`: T0

### `isInstanceOf[T0]`: Boolean
```

--------------------------------

### Standard Scala Methods (AnyRef/Throwable)

Source: https://www.javadoc.io/doc/com.beachape/enumeratum_2.13/latest/enumeratum/values/NoSuchMember.html

This section lists standard methods inherited from Scala's AnyRef and Throwable classes, which are commonly available on Enumeratum types.

```APIDOC
## final def !=(arg0: Any): Boolean

### Description
Tests whether this object (left) is not equal to x (right).

### Method
GET (Implicit)

### Endpoint
N/A

### Parameters
- **arg0** (Any) - The object to compare with.

### Response
#### Success Response (200)
- **result** (Boolean) - true if the objects are not equal, false otherwise.

## final def ##: Int

### Description
Returns a hash code value for the object. The default hash code implementation
does not guarantee any particular ordering or consistency across different
executions of the same program.

### Method
GET (Implicit)

### Endpoint
N/A

### Parameters
None

### Response
#### Success Response (200)
- **hashCode** (Int) - A hash code value for this object.

## final def ==(arg0: Any): Boolean

### Description
Tests whether x (left) is equal to y (right).

### Method
GET (Implicit)

### Endpoint
N/A

### Parameters
- **arg0** (Any) - The object to compare with.

### Response
#### Success Response (200)
- **result** (Boolean) - true if the objects are equal, false otherwise.

## final def addSuppressed(arg0: Throwable): Unit

### Description
Captures suppressible exceptions that are propagated during the execution of this
`Throwable`.

### Method
GET (Implicit)

### Endpoint
N/A

### Parameters
- **arg0** (Throwable) - The exception to suppress.

### Response
#### Success Response (200)
- **result** (Unit) - Indicates successful suppression.

## final def asInstanceOf[T0]: T0

### Description
Casts this object to be evaluated as an instance of the specified type `T0`.

### Method
GET (Implicit)

### Endpoint
N/A

### Parameters
- **T0** (Type Parameter) - The target type.

### Response
#### Success Response (200)
- **result** (T0) - The object cast to the specified type.

## def clone(): AnyRef

### Description
Creates and returns a copy of this object. The precise meaning of "copy" may depend
on the class of the object. The default implementation is a shallow copy.

### Method
GET (Implicit)

### Endpoint
N/A

### Parameters
None

### Response
#### Success Response (200)
- **clonedObject** (AnyRef) - A copy of the object.

### Throws
- **CloneNotSupportedException** - If the object's class does not support the `Cloneable` interface.

## final def eq(arg0: AnyRef): Boolean

### Description
Tests whether this object (left) is the same instance as x (right).

### Method
GET (Implicit)

### Endpoint
N/A

### Parameters
- **arg0** (AnyRef) - The object reference to compare with.

### Response
#### Success Response (200)
- **result** (Boolean) - true if the references point to the same object, false otherwise.

## def fillInStackTrace(): Throwable

### Description
Fills in the execution stack trace. By default, the stack trace is
constructed from the stack trace of the enclosing `Throwable`.

### Method
GET (Implicit)

### Endpoint
N/A

### Parameters
None

### Response
#### Success Response (200)
- **stackTraceThrowable** (Throwable) - The Throwable with its stack trace filled in.

## def getCause(): Throwable

### Description
Returns the cause of this throwable or null if the cause is nonexistent or unknown.

### Method
GET (Implicit)

### Endpoint
N/A

### Parameters
None

### Response
#### Success Response (200)
- **cause** (Throwable) - The cause of the exception, or null.

## final def getClass(): Class[_ <: AnyRef]

### Description
Returns the runtime type of this object.

### Method
GET (Implicit)

### Endpoint
N/A

### Parameters
None

### Response
#### Success Response (200)
- **runtimeClass** (Class[_ <: AnyRef]) - The runtime class of the object.

## def getLocalizedMessage(): String

### Description
Returns a localized descriptive message of this throwable.

### Method
GET (Implicit)

### Endpoint
N/A

### Parameters
None

### Response
#### Success Response (200)
- **localizedMessage** (String) - The localized descriptive message.

## def getMessage(): String

### Description
Returns the detail message string of this throwable.

### Method
GET (Implicit)

### Endpoint
N/A

### Parameters
None

### Response
#### Success Response (200)
- **message** (String) - The detail message string.

## def getStackTrace(): Array[StackTraceElement]

### Description
Returns an array containing the stack trace elements that represent the stack dump
concluding with the specified exception or error.

### Method
GET (Implicit)

### Endpoint
N/A

### Parameters
None

### Response
#### Success Response (200)
- **stackTrace** (Array[StackTraceElement]) - An array of stack trace elements.

## final def getSuppressed(): Array[Throwable]

### Description
Returns an array containing all of the exceptions and errors that were suppressed,
and therefore not sent to the default exception handler.

### Method
GET (Implicit)

### Endpoint
N/A

### Parameters
None

### Response
#### Success Response (200)
- **suppressedExceptions** (Array[Throwable]) - An array of suppressed exceptions.

## def initCause(arg0: Throwable): Throwable

### Description
Initializes the cause of this throwable to the specified value.

### Method
GET (Implicit)

### Endpoint
N/A

### Parameters
- **arg0** (Throwable) - The cause of the exception.

### Response
#### Success Response (200)
- **initializedThrowable** (Throwable) - The Throwable instance with its cause initialized.

## final def isInstanceOf[T0]: Boolean

### Description
Checks whether this object is an instance of the specified type `T0`.

### Method
GET (Implicit)

### Endpoint
N/A

### Parameters
- **T0** (Type Parameter) - The type to check against.

### Response
#### Success Response (200)
- **result** (Boolean) - true if the object is an instance of the type, false otherwise.

## final def ne(arg0: AnyRef): Boolean

### Description
Tests whether this object (left) is not equal to x (right).

### Method
GET (Implicit)

### Endpoint
N/A

### Parameters
- **arg0** (AnyRef) - The object reference to compare with.

### Response
#### Success Response (200)
- **result** (Boolean) - true if the references do not point to the same object, false otherwise.

## final def notify(): Unit

### Description
Awakens up a single thread that is waiting on this object's monitor.

### Method
GET (Implicit)

### Endpoint
N/A

### Parameters
None

### Response
#### Success Response (200)
- **result** (Unit) - Indicates successful notification.

## final def notifyAll(): Unit

### Description
Awakens up all threads that are waiting on this object's monitor.

### Method
GET (Implicit)

### Endpoint
N/A

### Parameters
None

### Response
#### Success Response (200)
- **result** (Unit) - Indicates successful notification.

## def printStackTrace(arg0: PrintWriter): Unit

### Description
Prints this throwable and its backtrace to the specified print writer.

### Method
GET (Implicit)

### Endpoint
N/A

### Parameters
- **arg0** (PrintWriter) - The print writer to use for output.

### Response
#### Success Response (200)
- **result** (Unit) - Indicates successful printing.

## def printStackTrace(arg0: PrintStream): Unit

### Description
Prints this throwable and its backtrace to the specified print stream.

### Method
GET (Implicit)

### Endpoint
N/A

### Parameters
- **arg0** (PrintStream) - The print stream to use for output.

### Response
#### Success Response (200)
- **result** (Unit) - Indicates successful printing.

## def printStackTrace(): Unit

### Description
Prints this throwable and its backtrace to the standard error stream.

### Method
GET (Implicit)

### Endpoint
N/A

### Parameters
None

### Response
#### Success Response (200)
- **result** (Unit) - Indicates successful printing.

## def productElementNames: Iterator[String]

### Description
Returns an iterator over the names of the elements of this product.

### Method
GET (Implicit)

### Endpoint
N/A

### Parameters
None

### Response
#### Success Response (200)
- **elementNames** (Iterator[String]) - An iterator of element names.

## def setStackTrace(arg0: Array[StackTraceElement]): Unit

### Description
Sets the stack trace elements for this `Throwable`.

### Method
GET (Implicit)

### Endpoint
N/A

### Parameters
- **arg0** (Array[StackTraceElement]) - The array of stack trace elements to set.

### Response
#### Success Response (200)
- **result** (Unit) - Indicates successful setting of the stack trace.

## final def synchronized[T0](arg0: => T0): T0

### Description
Executes the given code block within a synchronized region, ensuring mutual exclusion.

### Method
GET (Implicit)

### Endpoint
N/A

### Parameters
- **arg0** (=> T0) - The code block to execute.

### Response
#### Success Response (200)
- **result** (T0) - The result of the executed code block.

## def toString(): String

### Description
Returns a string representation of the object.

### Method
GET (Implicit)

### Endpoint
N/A

### Parameters
None

### Response
#### Success Response (200)
- **stringRepresentation** (String) - A string representation of the object.

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

### Description
Waits for at most a specified amount of time in milliseconds, and then
resumes execution. The actual waiting time depends on the system clock and
the scheduler.

### Method
GET (Implicit)

### Endpoint
N/A

### Parameters
- **arg0** (Long) - The maximum time to wait in milliseconds.
- **arg1** (Int) - The maximum time to wait in nanoseconds.

### Response
#### Success Response (200)
- **result** (Unit) - Indicates successful waiting.

### Throws
- **InterruptedException** - If any thread has interrupted the current thread.

## final def wait(arg0: Long): Unit

### Description
Waits for the specified amount of time in milliseconds, and then resumes execution.

### Method
GET (Implicit)

### Endpoint
N/A

### Parameters
- **arg0** (Long) - The time to wait in milliseconds.

### Response
#### Success Response (200)
- **result** (Unit) - Indicates successful waiting.

### Throws
- **InterruptedException** - If any thread has interrupted the current thread.

## final def wait(): Unit

### Description
Waits indefinitely until another thread invokes the `notify()` method or the
`notifyAll()` method for this object, or some other thread interrupts the
current thread.

### Method
GET (Implicit)

### Endpoint
N/A

### Parameters
None

### Response
#### Success Response (200)
- **result** (Unit) - Indicates successful waiting.

### Throws
- **InterruptedException** - If any thread has interrupted the current thread.

## def finalize(): Unit

### Description
Called by the garbage collector on an object when garbage collection
discovers that there are no more references to the object. A subclass overrides
the `finalize` method to dispose of system resources or to perform other cleanup.

### Method
GET (Implicit)

### Endpoint
N/A

### Parameters
None

### Response
#### Success Response (200)
- **result** (Unit) - Indicates successful finalization.

### Throws
- **Throwable** - If an error occurs during finalization.
```

--------------------------------

### IntEnumCompanion Object

Source: https://www.javadoc.io/doc/com.beachape/enumeratum_2.13/latest/enumeratum/values/IntEnum%24.html

Details about the IntEnumCompanion object, which provides methods for creating IntEnums.

```APIDOC
## IntEnumCompanion

### Description
Companion object for IntEnum, providing factory methods.

### Value Members
- `materialiseIntValueEnum[EntryType <: IntEnumEntry]: IntEnum[EntryType]` - Materializes an IntEnum for a given IntEnumEntry.
```
Tokens:
Raw