Package org.apache.juneau.console.widgets

Class ServerValuesValue

java.lang.Object

org.apache.juneau.console.widgets.ServerValuesValue

public final class ServerValuesValue
extends Object

An immutable named server-side scalar value declaration held by a ServerValues bean.

Each value pairs a stable name (the key an author interpolates as "$FV{name}") with a session-aware provider. The provider is invoked at serve time against a per-render VarResolverSession and must return a scalar (String / Number / Boolean) or null; non-scalar results are rejected at resolve time rather than toString()-ed.

cacheable defaults to false — the provider re-runs on every reference within a render. Set it true only for values that are stable across all references in a single response.

Since:

10.0.0

Field Summary

Fields

Modifier and Type	Field	Description
final boolean	cacheable	Whether the resolved value may be memoized for the lifetime of a single render.
final String	name	The interpolation name (the x in "$FV{x}").
final Function<VarResolverSession,?>	provider	The session-aware scalar provider.

Method Summary

Modifier and Type	Method	Description
static ServerValuesValue	of(String name, Function<VarResolverSession,?> provider)	Creates a non-cacheable value.
static ServerValuesValue	of(String name, Function<VarResolverSession,?> provider, boolean cacheable)	Creates a value with an explicit cacheable flag.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

name

public final String name

The interpolation name (the x in "$FV{x}"). Must not be null or blank.

provider

public final Function<VarResolverSession,?> provider

The session-aware scalar provider. Must not be null.

cacheable

public final boolean cacheable

Whether the resolved value may be memoized for the lifetime of a single render. Defaults to false.

Method Details

of

public static ServerValuesValue of(String name,
 Function<VarResolverSession,?> provider)

Creates a non-cacheable value.

Parameters:

name - The interpolation name.

provider - The session-aware scalar provider.

Returns:

A new ServerValuesValue with cacheable=false.

of

public static ServerValuesValue of(String name,
 Function<VarResolverSession,?> provider,
 boolean cacheable)

Creates a value with an explicit cacheable flag.

Parameters:

name - The interpolation name.

provider - The session-aware scalar provider.

cacheable - Whether the resolved value may be memoized within a single render.

Returns:

A new ServerValuesValue.