io.micronaut.views

Class TemplatedBuilder<T extends Renderable>

java.lang.Object

io.micronaut.views.TemplatedBuilder<T>

Type Parameters:

T - The class to be built

Direct Known Subclasses:

TurboFrame.Builder

public abstract class TemplatedBuilder<T extends Renderable>
extends java.lang.Object

Abstract class to be used by builders which support templates.

Since:

3.4.0

Author:

Sergio del Amo

Constructor Summary

Constructors

Constructor and Description
TemplatedBuilder()

Method Summary

Modifier and Type	Method and Description
abstract T	build()
java.lang.Object	getTemplate()
java.util.Optional<java.lang.Object>	getTemplateModel()
java.util.Optional<java.lang.String>	getTemplateView()
TemplatedBuilder<T>	template(java.lang.String html) Sets the Turbo Frame with a String.
TemplatedBuilder<T>	template(java.lang.String view, java.lang.Object model) Sets the template with a View and Model.
TemplatedBuilder<T>	template(io.micronaut.core.io.Writable writable) Sets the Turbo frame content with a Writable.
TemplatedBuilder<T>	templateModel(java.lang.Object templateModel) Sets the template's model.
TemplatedBuilder<T>	templateView(java.lang.String templateView) Sets the template's view name.

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplatedBuilder

public TemplatedBuilder()

Method Detail

build

public abstract T build()

Returns:

Build instance

getTemplateView

@NonNull
public java.util.Optional<java.lang.String> getTemplateView()

Returns:

The TurboStream template view name.

getTemplateModel

@NonNull
public java.util.Optional<java.lang.Object> getTemplateModel()

Returns:

The TurboStream template model.

getTemplate

@Nullable
public java.lang.Object getTemplate()

Returns:

The Template

template

@NonNull
public TemplatedBuilder<T> template(@NonNull
                                             java.lang.String view,
                                             java.lang.Object model)

Sets the template with a View and Model.

Parameters:

view - The View name

model - The Model

Returns:

The Builder

template

@NonNull
public TemplatedBuilder<T> template(@NonNull
                                             java.lang.String html)

Sets the Turbo Frame with a String. E.g. HTML.

Parameters:

html - The turbo frame content

Returns:

The Builder

template

@NonNull
public TemplatedBuilder<T> template(@NonNull
                                             io.micronaut.core.io.Writable writable)

Sets the Turbo frame content with a Writable.

Parameters:

writable - The template as a Writable.

Returns:

The Builder

templateView

@NonNull
public TemplatedBuilder<T> templateView(@NonNull
                                                 java.lang.String templateView)

Sets the template's view name.

Parameters:

templateView - The View name

Returns:

The Builder

templateModel

@NonNull
public TemplatedBuilder<T> templateModel(@NonNull
                                                  java.lang.Object templateModel)

Sets the template's model.

Parameters:

templateModel - template model.

Returns:

The Builder