Package org.apache.juneau.console

Class Subscription

java.lang.Object

org.apache.juneau.console.Subscription

public final class Subscription
extends Object

One entry of a card's subscribes list: a concrete topic wired to a role the card type implements.

Example:

// Master/detail: the tasks table reloads with the selected change's id. CardSpec tasks = CardSpec.of("datatables", "tasks") .subscribes(Subscription.to(Topics.selection("changes")).as("params") .map("changeId", "ids.0").whenEmpty(WhenEmpty.CLEAR) .emptyText("Select a change to see its tasks.")); // Linked filter, raw payload. Subscription.to(Topics.filter("changes")).as("filter");

Since:

10.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Subscription.WhenEmpty	What a subscriber does when the payload is cleared or a mapped path is missing.

Method Summary

Modifier and Type	Method	Description
Subscription	as(String role)
Subscription	emptyText(String v)
Subscription	map(String target, String path)	Maps one payload path to a target; repeatable.
static Subscription	to(String topic)
JsonMap	toMap()
String	topic()
Subscription	whenEmpty(Subscription.WhenEmpty v)

Methods inherited from class java.lang.Object

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

Method Details

to

public static Subscription to(String topic)

Parameters:

topic - A concrete topic; no wildcards.

Returns:

A new subscription.

Throws:

IllegalArgumentException - E-40 on bad syntax.

as

public Subscription as(String role)

Parameters:

role - A role the card type accepts, matching ^[a-z][a-z0-9-]{0,31}$. @return This object.

map

public Subscription map(String target,
 String path)

Maps one payload path to a target; repeatable.

Parameters:

target - A {token} name for params, or a dotted field such as columns.region for filter.

path - A dotted path into the payload, with numeric segments for array indexes, such as ids.0.

Returns:

This object.

whenEmpty

public Subscription whenEmpty(Subscription.WhenEmpty v)

Parameters:

v - Subscription.WhenEmpty.CLEAR (the default when unset) or Subscription.WhenEmpty.KEEP. @return This object.

emptyText

public Subscription emptyText(String v)

Parameters:

v - The text painted when the payload is empty; the shell's default otherwise. @return This object.

topic

public String topic()

Returns:

The topic.

toMap

public JsonMap toMap()

Returns:

The $defs/subscription entry.