Package com.inductiveautomation.ignition.gateway.dataroutes.openapi.annotations

Annotation Interface Enumeration

@Target(FIELD)
@Retention(RUNTIME)
public @interface Enumeration

Annotation for adding an enumeration of values to a Resource Schema object. This annotation is parsed by SchemaUtil.fromType to add an enumeration of values by first calling provider() to get the Enumeration.Provider class to instantiate, then calling the default constructor for the class to get a new instance of the Enumeration.Provider implementation, and then finally calling Enumeration.Provider.values() to get the enumeration values as an object array.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Enumeration.Provider	Interface for providing enumeration values

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
Class<? extends Enumeration.Provider>	provider

Element Details

provider

Class<? extends Enumeration.Provider> provider

Returns:

a Class of type Enumeration.Provider whose default constructor will be used to create a new instance the Enumeration.Provider which will then be used to call Enumeration.Provider.values() to derive the enumeration values to add to the schema definition.