EnumeratedValues.BasicValue (Pentaho Community Edition Project: mondrian 9.5.0.0-252 API)

java.lang.Object
- mondrian.olap.EnumeratedValues.BasicValue

All Implemented Interfaces:

EnumeratedValues.Value

Direct Known Subclasses:

Property, RolapAggregator

Enclosing class:

EnumeratedValues<V extends EnumeratedValues.Value>
```
public static class EnumeratedValues.BasicValue
extends Object
implements EnumeratedValues.Value
```
BasicValue is an obvious implementation of EnumeratedValues.Value.

Field Summary

Fields
Modifier and Type Field Description

String description

String name

int ordinal

Constructor Summary

Constructors
Constructor Description

BasicValue(String name, int ordinal, String description)

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`boolean`	`equals(String s)`	Deprecated. I bet you meant to write `value.name_.equals(s)` rather than `value.equals(s)`, didn't you?
`String`	`getDescription()`
`String`	`getName()`
`int`	`getOrdinal()`
`String`	`toString()`	Returns the value's name.
`RuntimeException`	`unexpected()`	Returns an error indicating that we did not expect to find this value in this context.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - name
```
public final String name
```
  - ordinal
```
public final int ordinal
```
  - description
```
public final String description
```
- Constructor Detail
  - BasicValue
```
public BasicValue(String name,
                  int ordinal,
                  String description)
```
- Method Detail
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface EnumeratedValues.Value
  - getOrdinal
```
public int getOrdinal()
```
    Specified by:
    
    getOrdinal in interface EnumeratedValues.Value
  - getDescription
```
public String getDescription()
```
    Specified by:
    
    getDescription in interface EnumeratedValues.Value
  - toString
```
public String toString()
```
    Returns the value's name.
    
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(String s)
```
    Deprecated.
    I bet you meant to write value.name_.equals(s) rather than value.equals(s), didn't you?
    
    Returns whether this value is equal to a given string.
  - unexpected
```
public RuntimeException unexpected()
```
    Returns an error indicating that we did not expect to find this value in this context. Typical use is in a switch statement:
    switch (fruit) { case Fruit.AppleORDINAL: return 1; case Fruir.OrangeORDINAL: return 2; default: throw fruit.unexpected(); }