Package org.apache.juneau.console.views

Class TerminalViewPage

java.lang.Object

org.apache.juneau.console.views.TerminalViewPage

public final class TerminalViewPage
extends Object

One page of a terminal-view event stream: the envelope the events endpoint returns and the client polls.

The wire form is {contractVersion, events, next, more, terminal}. A page with no events still carries next.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTRACT_VERSION	The contract version carried by every page.
static final int	MAX_PAGE_CHARS	The maximum serialized size of the events in one page.
static final int	MAX_PAGE_EVENTS	The maximum number of events in one page.

Method Summary

Modifier and Type	Method	Description
List<TerminalEvent>	events()	Returns the events.
boolean	more()	Returns whether the source holds further events right now.
String	next()	Returns the continuation token.
static TerminalViewPage	of(List<TerminalEvent> events, String next, boolean more, boolean terminal)	Creates a page.
boolean	terminal()	Returns whether the source will never produce another event.
Map<String,Object>	toContractMap()	Returns the page in its wire form.
TerminalViewPage	validate()	Validates the page: ascending numbered events, the token grammar, and the size caps.

Methods inherited from class java.lang.Object

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

Field Details

CONTRACT_VERSION

public static final String CONTRACT_VERSION

The contract version carried by every page.

See Also:

• Constant Field Values

MAX_PAGE_EVENTS

public static final int MAX_PAGE_EVENTS

The maximum number of events in one page.

See Also:

• Constant Field Values

MAX_PAGE_CHARS

public static final int MAX_PAGE_CHARS

The maximum serialized size of the events in one page.

See Also:

• Constant Field Values

Method Details

of

public static TerminalViewPage of(List<TerminalEvent> events,
 String next,
 boolean more,
 boolean terminal)

Creates a page.

Parameters:

events - The events, in ascending seq. Copied defensively.

next - The continuation token.

more - Whether the source holds further events right now.

terminal - Whether the source will never produce another event.

Returns:

A new page. Call validate() before sending it.

events

public List<TerminalEvent> events()

Returns the events.

Returns:

An unmodifiable list.

next

public String next()

Returns the continuation token.

Returns:

The token.

more

public boolean more()

Returns whether the source holds further events right now.

Returns:

true if so.

terminal

public boolean terminal()

Returns whether the source will never produce another event.

Returns:

true if so.

validate

public TerminalViewPage validate()

Validates the page: ascending numbered events, the token grammar, and the size caps.

Returns:

This object.

Throws:

IllegalArgumentException - If the page is not valid.

toContractMap

public Map<String,Object> toContractMap()

Returns the page in its wire form.

Returns:

An ordered map: contractVersion, events, next, more, terminal.