Package io.micronaut.views.turbo

Class DefaultTurboStreamRenderer

java.lang.Object

io.micronaut.views.turbo.DefaultTurboStreamRenderer

All Implemented Interfaces:

TurboStreamRenderer

@Singleton
@Requires(classes=io.micronaut.http.HttpRequest.class)
public class DefaultTurboStreamRenderer
extends Object
implements TurboStreamRenderer

DefaultImplementation of TurboStreamRenderer.

Since:

3.3.0

Author:

Sergio del Amo

Field Summary

Fields

Modifier and Type	Field	Description
protected final ViewsRendererLocator	viewsRendererLocator

Constructor Summary

Constructors

Constructor	Description
DefaultTurboStreamRenderer(ViewsRendererLocator viewsRendererLocator)	Deprecated, for removal: This API element is subject to removal in a future version. Use DefaultTurboStreamRenderer(ViewsRendererLocator, ViewsModelDecorator) instead.
DefaultTurboStreamRenderer(ViewsRendererLocator viewsRendererLocator, ViewsModelDecorator viewsModelDecorator)

Method Summary

Modifier and Type	Method	Description
@NonNull Optional<io.micronaut.core.io.Writable>	render(TurboStream.Builder builder, @Nullable io.micronaut.http.HttpRequest<?> request)

Methods inherited from class java.lang.Object

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

Field Details

viewsRendererLocator

protected final ViewsRendererLocator viewsRendererLocator

Constructor Details

DefaultTurboStreamRenderer

@Inject
public DefaultTurboStreamRenderer(ViewsRendererLocator viewsRendererLocator,
 ViewsModelDecorator viewsModelDecorator)

Parameters:

viewsRendererLocator - ViewRendererLocator

viewsModelDecorator - Views Model Decorator

DefaultTurboStreamRenderer

@Deprecated(since="5.2.1",
            forRemoval=true)
public DefaultTurboStreamRenderer(ViewsRendererLocator viewsRendererLocator)

Deprecated, for removal: This API element is subject to removal in a future version.

Use DefaultTurboStreamRenderer(ViewsRendererLocator, ViewsModelDecorator) instead.

Parameters:

viewsRendererLocator - View Renderer Locator

Method Details

render

@NonNull
public @NonNull Optional<io.micronaut.core.io.Writable> render(@NonNull
 TurboStream.Builder builder,
 @Nullable
 @Nullable io.micronaut.http.HttpRequest<?> request)

Specified by:

render in interface TurboStreamRenderer

Parameters:

builder - Turbo Stream builder

request - HTTP Request

Returns:

A Writable