Package com.inductiveautomation.historian.common.model.options

Enum Class ResultWriterOptions.ResultFormat

java.lang.Object

java.lang.Enum<ResultWriterOptions.ResultFormat>

com.inductiveautomation.historian.common.model.options.ResultWriterOptions.ResultFormat

All Implemented Interfaces:

Serializable, Comparable<ResultWriterOptions.ResultFormat>, Constable

Enclosing class:

ResultWriterOptions

public static enum ResultWriterOptions.ResultFormat
extends Enum<ResultWriterOptions.ResultFormat>

Enum representing the format of the query result.

Each format defines how the data is structured in the result.

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
CALCULATION
NONE
TALL
WIDE

Method Summary

Modifier and Type	Method	Description
static Optional<ResultWriterOptions.ResultFormat>	fromString(String value)	Parses a string to find a matching ResultFormat.
static ResultWriterOptions.ResultFormat	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ResultWriterOptions.ResultFormat[]	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

WIDE

public static final ResultWriterOptions.ResultFormat WIDE

TALL

public static final ResultWriterOptions.ResultFormat TALL

CALCULATION

public static final ResultWriterOptions.ResultFormat CALCULATION

NONE

public static final ResultWriterOptions.ResultFormat NONE

Method Details

values

public static ResultWriterOptions.ResultFormat[] 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 ResultWriterOptions.ResultFormat 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

fromString

public static Optional<ResultWriterOptions.ResultFormat> fromString(String value)

Parses a string to find a matching ResultFormat.

Parameters:

value - The string representation of the result format.

Returns:

An Optional containing the matching ResultFormat, or empty if no match is found.