Package org.apache.juneau.console.views

Class TerminalViewDef

java.lang.Object

org.apache.juneau.console.views.TerminalViewDef

public class TerminalViewDef
extends Object

The author-facing declaration of a terminal-view region, compiled to a RegionDef.

toRegion() produces a region with populate("terminal-view"), opts that populator in with allowPopulators("terminal-view"), and carries every setting as a flat params scalar. It never sets dataUrl or refreshMs on the region: the terminal view owns its own polling loop.

Example:

RegionDef region = TerminalViewDef.create("run") .eventsUrl("/runs/42/events") .title("Run 42") .toRegion();

Field Summary

Fields

Modifier and Type	Field	Description
boolean	compact	Compact mode.
static final long	DEFAULT_REFRESH_MS	The default poll interval in milliseconds.
String	eventsUrl	Events endpoint path template; required unless poll is false.
final String	id	Region id.
static final List<String>	KEYS	The param keys, in emission order.
static final long	MIN_REFRESH_MS	The refresh floor in milliseconds.
static final String	MIXIN_PREFIX	The path prefix used by forMixin(String, String, String); equals TerminalViewMixin.RUN_VIEW_PREFIX.
boolean	poll	Whether the region polls eventsUrl; false makes a region that only takes appended events.
static final String	POPULATOR	The populator name.
String	rawHref	Raw-console link template with one {offset} placeholder.
long	refreshMs	Poll interval in milliseconds.
String	title	Accessible name and heading.
String	type	Region type; defaults to RegionDef.TYPE_CARD_BODY.

Method Summary

Modifier and Type	Method	Description
TerminalViewDef	compact(boolean value)
static TerminalViewDef	create(String id)	Creates a declaration.
TerminalViewDef	eventsUrl(String value)
static TerminalViewDef	forMixin(String id, String mountPath, String runIdTemplate)	Creates a declaration whose events URL points at a TerminalViewMixin mounted at mountPath.
static TerminalViewDef	fromMap(String id, Map<String,?> map)	Creates a declaration from a parsed map (the console-ui card body).
TerminalViewDef	poll(boolean value)
TerminalViewDef	rawHref(String value)
TerminalViewDef	refreshMs(long value)
TerminalViewDef	title(String value)
Map<String,Object>	toMap()	Returns the set params in KEYS order, with refreshMs clamped.
RegionDef	toRegion()	Validates and compiles this declaration.
TerminalViewDef	type(String value)
TerminalViewDef	validate()	Validates this declaration (fail-closed).

Methods inherited from class java.lang.Object

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

Field Details

POPULATOR

public static final String POPULATOR

The populator name.

See Also:

• Constant Field Values

MIN_REFRESH_MS

public static final long MIN_REFRESH_MS

The refresh floor in milliseconds.

See Also:

• Constant Field Values

DEFAULT_REFRESH_MS

public static final long DEFAULT_REFRESH_MS

The default poll interval in milliseconds.

See Also:

• Constant Field Values

MIXIN_PREFIX

public static final String MIXIN_PREFIX

The path prefix used by forMixin(String, String, String); equals TerminalViewMixin.RUN_VIEW_PREFIX.

See Also:

• Constant Field Values

KEYS

public static final List<String> KEYS

The param keys, in emission order.

id

public final String id

Region id.

type

public String type

Region type; defaults to RegionDef.TYPE_CARD_BODY.

eventsUrl

public String eventsUrl

Events endpoint path template; required unless poll is false.

refreshMs

public long refreshMs

Poll interval in milliseconds.

poll

public boolean poll

Whether the region polls eventsUrl; false makes a region that only takes appended events.

compact

public boolean compact

Compact mode.

title

public String title

Accessible name and heading.

rawHref

public String rawHref

Raw-console link template with one {offset} placeholder.

Method Details

create

public static TerminalViewDef create(String id)

Creates a declaration.

Parameters:

id - The region id.

Returns:

A new declaration.

forMixin

public static TerminalViewDef forMixin(String id,
 String mountPath,
 String runIdTemplate)

Creates a declaration whose events URL points at a TerminalViewMixin mounted at mountPath.

Parameters:

id - The region id.

mountPath - The resource mount path, for example "/petstore".

runIdTemplate - "{id}" (the client row-id placeholder) or a literal run id.

Returns:

A new declaration.

fromMap

public static TerminalViewDef fromMap(String id,
 Map<String,?> map)

Creates a declaration from a parsed map (the console-ui card body).

Parameters:

id - The card id.

map - The terminalView object; keys must be a subset of KEYS.

Returns:

A new declaration (not yet validated).

type

public TerminalViewDef type(String value)

Parameters:

value - The region type. @return This object.

eventsUrl

public TerminalViewDef eventsUrl(String value)

Parameters:

value - The events endpoint path template. @return This object.

refreshMs

public TerminalViewDef refreshMs(long value)

Parameters:

value - The poll interval; clamped to MIN_REFRESH_MS. @return This object.

poll

public TerminalViewDef poll(boolean value)

Parameters:

value - Whether to poll. @return This object.

compact

public TerminalViewDef compact(boolean value)

Parameters:

value - Compact mode. @return This object.

title

public TerminalViewDef title(String value)

Parameters:

value - The accessible name and heading. @return This object.

rawHref

public TerminalViewDef rawHref(String value)

Parameters:

value - The raw-console link template, with one {offset}. @return This object.

validate

public TerminalViewDef validate()

Validates this declaration (fail-closed).

Returns:

This object.

Throws:

IllegalArgumentException - If a rule is broken.

toMap

public Map<String,Object> toMap()

Returns the set params in KEYS order, with refreshMs clamped.

Returns:

A new ordered map.

toRegion

public RegionDef toRegion()

Validates and compiles this declaration.

Returns:

A validated region.