Package org.freeplane.api.ai

Enum Class AiToolAvailability

java.lang.Object

java.lang.Enum<AiToolAvailability>

org.freeplane.api.ai.AiToolAvailability

All Implemented Interfaces:

Serializable, Comparable<AiToolAvailability>, Constable

public enum AiToolAvailability
extends Enum<AiToolAvailability>

Tool availability requested for an AI call.

CURRENT means the request should use the current AI tool setting. To inherit a saved prompt's own setting, leave AiRequestOptions.Builder.toolAvailability(AiToolAvailability) unset.

Since:

1.13.3

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
CURRENT	Use the current AI tool setting.
DISABLED	Disable application tools for the request.
EDITING	Allow Freeplane reading and map-editing tools, but not script/code execution tools.
READING	Allow Freeplane read/search/selection tools only.
SCRIPT_EXECUTION	Allow editing tools and script/code execution tools where those tools are enabled and authorized.

Method Summary

Modifier and Type	Method	Description
static AiToolAvailability	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AiToolAvailability[]	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

CURRENT

public static final AiToolAvailability CURRENT

Use the current AI tool setting.

DISABLED

public static final AiToolAvailability DISABLED

Disable application tools for the request.

READING

public static final AiToolAvailability READING

Allow Freeplane read/search/selection tools only.

EDITING

public static final AiToolAvailability EDITING

Allow Freeplane reading and map-editing tools, but not script/code execution tools.

SCRIPT_EXECUTION

public static final AiToolAvailability SCRIPT_EXECUTION

Allow editing tools and script/code execution tools where those tools are enabled and authorized.

Method Details

values

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