Enum Class EngineType

java.lang.Object

java.lang.Enum<EngineType>

org.vaadin.addons.antlerflow.tour.EngineType

All Implemented Interfaces:

Serializable, Comparable<EngineType>, Constable

public enum EngineType
extends Enum<EngineType>

Enum representing the types of engines that can be used for guided tours.

 The available engine types include:
 - DRIVER: Represents the "driver" engine for managing tours.
 - SHEPHERD: Represents the "shepherd" engine for managing tours.
 

Each engine type has a unique identifier associated with it, which can be retrieved using the `getId` method.

This enum is used in the Tour class to specify the underlying tour engine that drives the tour functionality.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DRIVER
SHEPHERD

Method Summary

Modifier and Type	Method	Description
abstract TourEngine	getEngineInstance()
static EngineType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EngineType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DRIVER

public static final EngineType DRIVER

SHEPHERD

public static final EngineType SHEPHERD

Method Details

values

public static EngineType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static EngineType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getEngineInstance

public abstract TourEngine getEngineInstance()