EnumLiteral (Configuration 0.6.0 API)

java.lang.Object
- de.iip_ecosphere.platform.configuration.opcua.data.Literal
- - de.iip_ecosphere.platform.configuration.opcua.data.EnumLiteral

```
public class EnumLiteral
extends Literal
```
Represents an OPC UA enumeration literal.

Author:

Jan-Hendrik Cepok, SSE

Field Summary

Fields
Modifier and Type Field Description

private java.lang.String ordinal

Constructor Summary

Constructors
Constructor	Description
`EnumLiteral(java.lang.String name, java.lang.String ordinal, java.lang.String description)`	Creates an enumeration literal instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`getOrdinal()`	Returns the ordinal.
`java.lang.String`	`toString()`	Formats the OPC UA literal in IVML.

Methods inherited from class de.iip_ecosphere.platform.configuration.opcua.data.Literal
getDescription, getName

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

- Field Detail
  - ordinal
```
private java.lang.String ordinal
```
- Constructor Detail
  - EnumLiteral
```
public EnumLiteral(java.lang.String name,
                   java.lang.String ordinal,
                   java.lang.String description)
```
    Creates an enumeration literal instance.
    
    Parameters:
    
    name - the name of the literal
    
    ordinal - the ordinal value
    
    description - the description of the literal
- Method Detail
  - getOrdinal
```
public java.lang.String getOrdinal()
```
    Returns the ordinal.
    
    Returns:
    
    the ordinal
  - toString
```
public java.lang.String toString()
```
    Description copied from class: Literal
    
    Formats the OPC UA literal in IVML.
    
    Overrides:
    
    toString in class Literal
    
    Returns:
    
    the IVML representation of the OPC UA literal