Package io.quarkus.qute

Interface TemplateInstance

All Known Implementing Classes:

TemplateInstanceBase

public interface TemplateInstance

Represents an instance of Template.

This construct is not thread-safe.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	TemplateInstance.Initializer	This component can be used to initialize a template instance, i.e.

Field Summary

Fields

Modifier and Type	Field	Description
static String	SELECTED_VARIANT	Attribute key - a selected variant.
static String	TIMEOUT	Attribute key - the timeout for render() in milliseconds.
static String	VARIANTS	Attribute key - all template variants found.

Method Summary

Modifier and Type	Method	Description
CompletionStage<Void>	consume(Consumer<String> consumer)	Triggers rendering.
io.smallrye.mutiny.Multi<String>	createMulti()	Create a new Multi that can be used to consume chunks of the rendered template.
io.smallrye.mutiny.Uni<String>	createUni()	Create a new Uni that can be used to consume the rendered template.
TemplateInstance	data(Object data)	Set the the root data object.
TemplateInstance	data(String key, Object data)	Put the data in a map.
Object	getAttribute(String key)
Template	getTemplate()
long	getTimeout()
TemplateInstance	onRendered(Runnable action)	Register an action that is performed after the rendering is finished.
String	render()	Triggers rendering.
CompletionStage<String>	renderAsync()	Triggers rendering.
TemplateInstance	setAttribute(String key, Object value)

Field Detail

TIMEOUT

static final String TIMEOUT

Attribute key - the timeout for render() in milliseconds.

See Also:

getTimeout(), Constant Field Values

VARIANTS

static final String VARIANTS

Attribute key - all template variants found.

See Also:

Constant Field Values

SELECTED_VARIANT

static final String SELECTED_VARIANT

Attribute key - a selected variant.

See Also:

Constant Field Values

Method Detail

data

TemplateInstance data(Object data)

Set the the root data object. Invocation of this method removes any data set previously by data(String, Object).

Parameters:

data -

Returns:

data

TemplateInstance data(String key,
                      Object data)

Put the data in a map. The map will be used as the root context object during rendering. Invocation of this method removes the root data object previously set by data(Object).

Parameters:

key -

data -

Returns:

self

setAttribute

TemplateInstance setAttribute(String key,
                              Object value)

Parameters:

key -

value -

Returns:

self

getAttribute

Object getAttribute(String key)

Parameters:

key -

Returns:

the attribute or null

render

String render()

Triggers rendering. Note that this method blocks the current thread!

Returns:

the rendered template as string

renderAsync

CompletionStage<String> renderAsync()

Triggers rendering.

Returns:

a completion stage that is completed once the rendering finished

createMulti

io.smallrye.mutiny.Multi<String> createMulti()

Create a new Multi that can be used to consume chunks of the rendered template. In particular, each item represents a part of the rendered template.

This operation does not trigger rendering. Instead, each subscription triggers a new rendering of the template.

Returns:

a new Multi

See Also:

Multi.subscribe()

createUni

io.smallrye.mutiny.Uni<String> createUni()

Create a new Uni that can be used to consume the rendered template.

This operation does not trigger rendering. Instead, each subscription triggers a new rendering of the template.

Returns:

a new Uni

See Also:

Uni.subscribe()

consume

CompletionStage<Void> consume(Consumer<String> consumer)

Triggers rendering.

Parameters:

consumer - To consume chunks of the rendered template

Returns:

a completion stage that is completed once the rendering finished

getTimeout

long getTimeout()

Returns:

the timeout

See Also:

TIMEOUT

getTemplate

Template getTemplate()

Returns:

the original template

onRendered

TemplateInstance onRendered(Runnable action)

Register an action that is performed after the rendering is finished.

Parameters:

action -

Returns:

self