Package io.quarkus.qute

Class ForwardingTemplateInstance

java.lang.Object

io.quarkus.qute.ForwardingTemplateInstance

All Implemented Interfaces:

TemplateInstance

Direct Known Subclasses:

ResultsCollectingTemplateInstance

public abstract class ForwardingTemplateInstance
extends Object
implements TemplateInstance

Nested Class Summary

Nested classes/interfaces inherited from interface io.quarkus.qute.TemplateInstance

TemplateInstance.Initializer

Field Summary

Fields inherited from interface io.quarkus.qute.TemplateInstance

LOCALE, SELECTED_VARIANT, TIMEOUT, VARIANTS

Constructor Summary

Constructors

Constructor	Description
ForwardingTemplateInstance()

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.
protected abstract TemplateInstance	delegate()
Object	getAttribute(String key)
Template	getFragment(String id)
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)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.quarkus.qute.TemplateInstance

computedData, setLocale, setLocale, setVariant

Constructor Details

ForwardingTemplateInstance

public ForwardingTemplateInstance()

Method Details

delegate

protected abstract TemplateInstance delegate()

data

public TemplateInstance data(Object data)

Description copied from interface: TemplateInstance

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

Specified by:

data in interface TemplateInstance

Returns:

data

public TemplateInstance data(String key,
 Object data)

Description copied from interface: TemplateInstance

Put the data in a map. The map will be used as the root context object during rendering. Remove the root data object previously set by TemplateInstance.data(Object).

Specified by:

data in interface TemplateInstance

Returns:

self

setAttribute

public TemplateInstance setAttribute(String key,
 Object value)

Specified by:

setAttribute in interface TemplateInstance

Returns:

self

getAttribute

public Object getAttribute(String key)

Specified by:

getAttribute in interface TemplateInstance

Returns:

the attribute or null

render

public String render()

Description copied from interface: TemplateInstance

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

Specified by:

render in interface TemplateInstance

Returns:

the rendered template as string

renderAsync

public CompletionStage<String> renderAsync()

Description copied from interface: TemplateInstance

Triggers rendering.

Specified by:

renderAsync in interface TemplateInstance

Returns:

a completion stage that is completed once the rendering finished

createMulti

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

Description copied from interface: TemplateInstance

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.

Specified by:

createMulti in interface TemplateInstance

Returns:

a new Multi

See Also:

• Multi.subscribe()

createUni

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

Description copied from interface: TemplateInstance

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.

Specified by:

createUni in interface TemplateInstance

Returns:

a new Uni

See Also:

• Uni.subscribe()

consume

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

Description copied from interface: TemplateInstance

Triggers rendering.

Specified by:

consume in interface TemplateInstance

Parameters:

consumer - To consume chunks of the rendered template

Returns:

a completion stage that is completed once the rendering finished

getTimeout

public long getTimeout()

Specified by:

getTimeout in interface TemplateInstance

Returns:

the timeout

See Also:

• TemplateInstance.TIMEOUT

getTemplate

public Template getTemplate()

Specified by:

getTemplate in interface TemplateInstance

Returns:

the original template

getFragment

public Template getFragment(String id)

Specified by:

getFragment in interface TemplateInstance

Returns:

the fragment or null

See Also:

• Template.getFragment(String)

onRendered

public TemplateInstance onRendered(Runnable action)

Description copied from interface: TemplateInstance

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

Specified by:

onRendered in interface TemplateInstance

Returns:

self