---
title: "Enumerations"
url: https://docs.zeroc.com/ice/3.8/slice/user-defined-types/enumerations
language: java
docs_index: https://docs.zeroc.com/llms.txt
---

> For an index of every page, see [llms.txt](https://docs.zeroc.com/llms.txt).

# Enumerations

Programming language: Java. Other languages: [C++](https://docs.zeroc.com/ice/3.8/slice/user-defined-types/enumerations/cpp.md), [C#](https://docs.zeroc.com/ice/3.8/slice/user-defined-types/enumerations/csharp.md), [JavaScript](https://docs.zeroc.com/ice/3.8/slice/user-defined-types/enumerations/js.md), [MATLAB](https://docs.zeroc.com/ice/3.8/slice/user-defined-types/enumerations/matlab.md), [PHP](https://docs.zeroc.com/ice/3.8/slice/user-defined-types/enumerations/php.md), [Python](https://docs.zeroc.com/ice/3.8/slice/user-defined-types/enumerations/python.md), [Ruby](https://docs.zeroc.com/ice/3.8/slice/user-defined-types/enumerations/ruby.md), [Swift](https://docs.zeroc.com/ice/3.8/slice/user-defined-types/enumerations/swift.md).

## Enumeration Syntax and Semantics

An enumeration defines a set of named values, its enumerators:

```slice
module M
{
    enum Fruit { Apple, Pear, Orange }
}
```

This definition introduces a new type named `Fruit`. By default, the first enumerator has a value of zero, with sequentially increasing values for subsequent enumerators.

A Slice enum type introduces a new namespace scope, so the following is legal:

```slice
module M
{
    enum Fruit { Apple, Pear, Orange }
    enum ComputerBrands { Apple, Dell, HP, Lenovo }
}
```

The example below shows how to refer to an enumerator from a different scope:

```slice
module M
{
    enum Color { Red, Green, Blue }
}

module N
{
    struct Pixel
    {
        M::Color c = Blue;
    }
}
```

Slice does not permit empty enumerations.

> **Note**
>
> In Ice releases prior to Ice 3.7, an enum type did not create a new namespace and its enumerators were in the same namespace as the enum type itself. With these releases, you had to select longer enumerator names to avoid a naming clash.

## Custom Enumerator Values

Slice also permits you to assign custom values to enumerators:

```slice
const int PearValue = 7;
enum Fruit { Apple = 0, Pear = PearValue, Orange }
```

Custom values must be unique and non-negative, and may refer to Slice constants of integer types. If no custom value is specified for an enumerator, its value is one greater than the enumerator that immediately precedes it. In the example above, `Orange` has the value 8.

The maximum value for an enumerator value is the same as the maximum value for `int`, 2<sup>31</sup> - 1.

Slice does not require custom enumerator values to be declared in increasing order:

```slice
enum Fruit { Apple = 5, Pear = 3, Orange = 1 }   // Legal
```

The language mapping determines whether a program can compare two enumerators for order, and whether such a comparison follows the enumerators' values or their declaration order.

> **Warning**
>
> For an application that is still using version 1.0 of the [Ice encoding](https://docs.zeroc.com/ice/3.8/encoding/basic-data-encoding.md), changing the definition of an enumerated type **may** break backward compatibility with existing applications. For more information, please refer to the [encoding rules](https://docs.zeroc.com/ice/3.8/encoding/basic-data-encoding.md) for enumerators.

## Language Mapping

A Slice enumeration maps to the corresponding enumeration in Java. For example:

```slice
enum Fruit { Apple, Pear, Orange }
```

The Java mapping for `Fruit` is shown below:

```java
public enum Fruit {
    Apple,
    Pear,
    Orange;

    public int value();

    public static Fruit valueOf(int v);

    // ...
}
```

Given the above definitions, we can use enumerated values as follows:

```java
Fruit f1 = Fruit.Apple;
Fruit f2 = Fruit.Orange;

if (f1 == Fruit.Apple) { // Compare with constant
    // ...
}

if (f1 == f2) { // Compare two enums
    // ...
}

switch (f2) {   // Switch on enum
    case Apple:
        // ...
        break;
    case Pear:
        // ...
        break;
    case Orange:
        // ...
        break;
}
```

The Java mapping includes two methods of interest. The `value` method returns the Slice value of an enumerator, which is not necessarily the same as its ordinal value. The `valueOf` method translates a Slice value into its corresponding enumerator, or returns `null` if no match is found.

In the `Fruit` definition above, the Slice value of each enumerator matches its ordinal value. This will not be true if we modify the definition to include a custom enumerator value:

```slice
enum Fruit { Apple, Pear = 3, Orange }
```

The table below shows the new relationship between ordinal value and Slice value:

| **Enumerator** | **Ordinal** | **Slice** |
| --- | --- | --- |
| `Apple` | 0 | 0 |
| `Pear` | 1 | 3 |
| `Orange` | 2 | 4 |

> **Tip**
>
> Java enumerated types inherit implicitly from `java.lang.Enum`, which defines methods such as `ordinal` and `compareTo` that operate on the *ordinal* value of an enumerator, not its Slice value.

## See Also

- [Constants and Literals](https://docs.zeroc.com/ice/3.8/slice/constants-and-literals/java.md)
