io.knotx.dataobjects

Class Fragment

java.lang.Object

io.knotx.dataobjects.Fragment

public class Fragment
extends Object

An entity representing a markup slice produced during Template fragmentation. It represents both markup with static and dynamic content.

Constructor Summary

Constructors

Constructor and Description
Fragment(io.vertx.core.json.JsonObject fragment)

Method Summary

Modifier and Type	Method and Description
String	content()
Fragment	content(String content)
io.vertx.core.json.JsonObject	context()
boolean	equals(Object o)
boolean	failed()
Fragment	failure(String knot, Throwable t)
Optional<String>	fallback()
static Fragment	fallback(String data, String fallbackId)
static Fragment	fallback(String data, String fallbackId, String strategy)
String	getAttribute(String key)
int	hashCode()
boolean	isFallback()
boolean	isRaw()
List<KnotTask>	knotRouting()
List<String>	knots()
static Fragment	raw(String data)
Fragment	setAttribute(String key, String value)
static Fragment	snippet(List<String> knots, String data)
static Fragment	snippet(List<String> knots, String data, String fallback)
Fragment	success(String knot)
io.vertx.core.json.JsonObject	toJson()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Fragment

public Fragment(io.vertx.core.json.JsonObject fragment)

Method Detail

raw

public static Fragment raw(String data)

snippet

public static Fragment snippet(List<String> knots,
                               String data,
                               String fallback)

snippet

public static Fragment snippet(List<String> knots,
                               String data)

fallback

public static Fragment fallback(String data,
                                String fallbackId)

fallback

public static Fragment fallback(String data,
                                String fallbackId,
                                String strategy)

fallback

public Optional<String> fallback()

Returns:

replacement markup that should be rendered if this Fragment has failed. Can be empty string. Absent value indicates that no replacement markup is provided.

toJson

public io.vertx.core.json.JsonObject toJson()

knots

public List<String> knots()

Returns:

list of Knots identifiers that are used during Knot usage decision.

knotRouting

public List<KnotTask> knotRouting()

content

public String content()

Returns:

markup content of this fragment.

content

public Fragment content(String content)

setAttribute

public Fragment setAttribute(String key,
                             String value)

getAttribute

public String getAttribute(String key)

context

public io.vertx.core.json.JsonObject context()

Returns:

a JsonObject containing the data produced during Knots chain processing and used to exchange the context between them, e.g. ActionKnot can put there `action` context that contains data accumulated during action processing.

isRaw

public boolean isRaw()

Returns:

true if this Fragment has no dynamic parts (contains only static markup).

isFallback

public boolean isFallback()

failed

public boolean failed()

Returns:

true if processing of this Fragment has failed

failure

public Fragment failure(String knot,
                        Throwable t)

success

public Fragment success(String knot)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object