Package org.apache.juneau.console

Class CardSource

java.lang.Object

org.apache.juneau.console.CardSource

public final class CardSource
extends Object

One authored card handed to a CardTypeHandler: its attributes, its raw body, and helpers to parse the body as JSON5 or capture it as a <template data-card>. Built by <@card> and by C3's PageSpec; tests build it directly.

Example:

CardSource s = CardSource.create("datatables", "releases") .title("Releases") .body("{dataUrl:'/rest/releases/data', columns:[{key:'version', label:'Version'}]}") .build(); JsonMap frag = CardTypeRegistry.standard().handler("datatables").toFragment(s);

Since:

10.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CardSource.Builder	Builds a CardSource.

Method Summary

Modifier and Type	Method	Description
String	body()
Map<String,Object>	bodyMap()
String	captureTemplate()	Registers the raw body as a <template data-card="{id}"> via the builder's CardSource.Builder.templateSink and returns the card's own id as the template name.
static CardSource.Builder	create(String type, String id)	Starts building a CardSource.
IllegalArgumentException	error(String fmt, Object... args)	Builds an IllegalArgumentException whose message is prefixed with "<@card id='%s'> ".
boolean	hasJsonBody()
String	id()
JsonMap	json()	Parses the body as JSON5 (cached after the first call).
String	src()
String	title()
String	type()

Methods inherited from class java.lang.Object

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

Method Details

create

public static CardSource.Builder create(String type,
 String id)

Starts building a CardSource.

Parameters:

type - The card type name. Must not be null or blank.

id - The card id. Must not be null or blank.

Returns:

A new CardSource.Builder.

Throws:

IllegalArgumentException - If type or id is null or blank.

type

public String type()

Returns:

The card type name.

id

public String id()

Returns:

The card id.

title

public String title()

Returns:

The card title, or null.

src

public String src()

Returns:

The card's data-source URL, or null.

body

public String body()

Returns:

The raw, trimmed body, or null when absent.

hasJsonBody

public boolean hasJsonBody()

Returns:

true when CardSource.Builder.bodyMap(Map) was used, or the raw body's first non-whitespace character is an opening curly brace.

json

public JsonMap json()

Parses the body as JSON5 (cached after the first call).

Returns:

The parsed body, or the CardSource.Builder.bodyMap(Map) wrapped as a JsonMap when that was used.

Throws:

IllegalArgumentException - E-25 if the body is not JSON5 shaped; E-24 if it is but fails to parse.

bodyMap

public Map<String,Object> bodyMap()

Returns:

The pre-built map passed to CardSource.Builder.bodyMap(Map) (the C3 path), or null.

captureTemplate

public String captureTemplate()

Registers the raw body as a <template data-card="{id}"> via the builder's CardSource.Builder.templateSink and returns the card's own id as the template name.

Returns:

id().

Throws:

IllegalArgumentException - If the body is absent/blank, or no template sink was registered.

error

public IllegalArgumentException error(String fmt,
 Object... args)

Builds an IllegalArgumentException whose message is prefixed with "<@card id='%s'> ".

Parameters:

fmt - A String.format(String, Object...) pattern, using %s placeholders.

args - The format arguments.

Returns:

A new, unthrown exception (callers throw it themselves).