io.micronaut.views.turbo

Class TurboStream.Builder

java.lang.Object

io.micronaut.views.turbo.TurboStream.Builder

Enclosing class:

TurboStream

public static class TurboStream.Builder
extends java.lang.Object

Turbo Stream Builder.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
TurboStream.Builder	action(TurboStreamAction action)
TurboStream.Builder	after() Sets the Turbo action as TurboStreamAction.AFTER.
TurboStream.Builder	append() Sets the Turbo action as TurboStreamAction.APPEND.
TurboStream.Builder	before() Sets the Turbo action as TurboStreamAction.BEFORE.
TurboStream	build()
java.util.Optional<java.lang.String>	getTargetCssQuerySelector()
java.util.Optional<java.lang.String>	getTargetDomId()
java.util.Optional<java.lang.Object>	getTemplateModel()
java.util.Optional<java.lang.String>	getTemplateView()
static java.util.Optional<TurboStream.Builder>	of(io.micronaut.http.HttpRequest<?> request, io.micronaut.http.HttpResponse<?> response) Creates a Turbo Stream builder if annotation TurboView is found in the route and the request is a turbo request.
TurboStream.Builder	prepend() Sets the Turbo action as TurboStreamAction.PREPEND.
TurboStream.Builder	remove() Sets the Turbo action as TurboStreamAction.REMOVE.
TurboStream.Builder	replace() Sets the Turbo action as TurboStreamAction.REPLACE.
TurboStream.Builder	targetCssQuerySelector(java.lang.String targetCssQuerySelector)
TurboStream.Builder	targetCssQuerySelectorPattern(java.util.regex.Pattern pattern)
TurboStream.Builder	targetDomId(java.lang.String targetDomId)
TurboStream.Builder	targetDomIdPattern(java.util.regex.Pattern pattern)
TurboStream.Builder	template(java.lang.String html) Sets the Turbo template with a String.
TurboStream.Builder	template(java.lang.String view, java.lang.Object model) Sets the template with a View and Model.
TurboStream.Builder	template(io.micronaut.core.io.Writable writable) Sets the Turbo template with a Writable.
TurboStream.Builder	templateModel(java.lang.Object templateModel) Sets the template's model.
TurboStream.Builder	templateView(java.lang.String templateView) Sets the template's view name.
TurboStream.Builder	update() Sets the Turbo action as TurboStreamAction.UPDATE.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

targetCssQuerySelectorPattern

@NonNull
public TurboStream.Builder targetCssQuerySelectorPattern(@Nullable
                                                                  java.util.regex.Pattern pattern)

Parameters:

pattern - HTML attributes validation Pattern

Returns:

The Builder

targetDomIdPattern

@NonNull
public TurboStream.Builder targetDomIdPattern(@Nullable
                                                       java.util.regex.Pattern pattern)

Parameters:

pattern - HTML attributes validation Pattern

Returns:

The Builder

action

@NonNull
public TurboStream.Builder action(@NonNull
                                           TurboStreamAction action)

Parameters:

action - Sets the Turbo Stream Action

Returns:

The Builder

targetDomId

@NonNull
public TurboStream.Builder targetDomId(@NonNull
                                                java.lang.String targetDomId)

Parameters:

targetDomId - Target DOM ID

Returns:

The Builder

targetCssQuerySelector

@NonNull
public TurboStream.Builder targetCssQuerySelector(@NonNull
                                                           java.lang.String targetCssQuerySelector)

Parameters:

targetCssQuerySelector - Target CSS Query Selector

Returns:

The Builder

template

@NonNull
public TurboStream.Builder 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

templateView

@NonNull
public TurboStream.Builder templateView(@NonNull
                                                 java.lang.String templateView)

Sets the template's view name.

Parameters:

templateView - The View name

Returns:

The Builder

templateModel

@NonNull
public TurboStream.Builder templateModel(@NonNull
                                                  java.lang.Object templateModel)

Sets the template's model.

Parameters:

templateModel - template model.

Returns:

The Builder

template

@NonNull
public TurboStream.Builder template(@NonNull
                                             java.lang.String html)

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

Parameters:

html - The turbo template

Returns:

The Builder

template

@NonNull
public TurboStream.Builder template(@NonNull
                                             io.micronaut.core.io.Writable writable)

Sets the Turbo template with a Writable.

Parameters:

writable - The template as a Writable.

Returns:

The Builder

append

@NonNull
public TurboStream.Builder append()

Sets the Turbo action as TurboStreamAction.APPEND.

Returns:

The Builder.

prepend

@NonNull
public TurboStream.Builder prepend()

Sets the Turbo action as TurboStreamAction.PREPEND.

Returns:

The Builder

update

@NonNull
public TurboStream.Builder update()

Sets the Turbo action as TurboStreamAction.UPDATE.

Returns:

The Builder

remove

@NonNull
public TurboStream.Builder remove()

Sets the Turbo action as TurboStreamAction.REMOVE.

Returns:

The Builder.

after

@NonNull
public TurboStream.Builder after()

Sets the Turbo action as TurboStreamAction.AFTER.

Returns:

The Builder.

before

@NonNull
public TurboStream.Builder before()

Sets the Turbo action as TurboStreamAction.BEFORE.

Returns:

the Builder

replace

@NonNull
public TurboStream.Builder replace()

Sets the Turbo action as TurboStreamAction.REPLACE.

Returns:

the Builder

build

@NonNull
public TurboStream build()

Returns:

Builds the TurboStream.

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.

getTargetDomId

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

Returns:

TurboFrame Target DOM ID.

getTargetCssQuerySelector

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

Returns:

TurboFrame Target DOM ID.

of

@NonNull
public static java.util.Optional<TurboStream.Builder> of(@NonNull
                                                                  io.micronaut.http.HttpRequest<?> request,
                                                                  @NonNull
                                                                  io.micronaut.http.HttpResponse<?> response)

Creates a Turbo Stream builder if annotation TurboView is found in the route and the request is a turbo request.

Parameters:

request - HTTP Request

response - HTTP Response

Returns:

Creates a Turbo Stream builder if annotation TurboView is found in the route and the request is a turbo request.