Enum Class AiToolScope

java.lang.Object

java.lang.Enum<AiToolScope>

com.suncode.pwfl.ai.tool.AiToolScope

All Implemented Interfaces:

Serializable, Comparable<AiToolScope>, Constable

@Api
public enum AiToolScope
extends Enum<AiToolScope>

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL	Tool available on both client and server side.
CLIENT	Tool available only on the browser/client side.
SERVER	Tool available only on the server side.

Method Summary

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

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CLIENT

public static final AiToolScope CLIENT

Tool available only on the browser/client side.

SERVER

public static final AiToolScope SERVER

Tool available only on the server side.

ALL

public static final AiToolScope ALL

Tool available on both client and server side.

Method Details

values

public static AiToolScope[] 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 AiToolScope 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