Spring Framework 6.1.4 · org.springframework.web.reactive.result.view.HttpMessageWriterView

Modifier and Type	Field and Description
private final boolean	canWriteMap
private final Set<String>	modelKeys
private final HttpMessageWriter<?>	writer

Access	Constructor and Description
public	HttpMessageWriterView(Encoder<?> encoder) Constructor with an `Encoder`.
public	HttpMessageWriterView(HttpMessageWriter<?> writer) Constructor with a fully initialized `HttpMessageWriter`.

Method Summary

Modifier and Type	Method and Description
public HttpMessageWriter<?>	getMessageWriter() Return the configured message writer.
public final Set<String>	getModelKeys() Return the configured model keys.
private Object	getObjectToRender(Map<String, ?> model)
public List<MediaType>	getSupportedMediaTypes() Overrides default org.springframework.web.reactive.result.view.View.getSupportedMediaTypes. Return the list of media types this View supports, or an empty list.
private boolean	isMatch(Map.Entry<String, ?> entry)
public Mono<Void>	render(Map<String, ?> a Map with name Strings as keys and corresponding model objects as values (Map can also be `null` in case of empty model) model, MediaType the content type selected to render with which should match one of the `supported media types`. contentType, ServerWebExchange the current exchange exchange) Implements org.springframework.web.reactive.result.view.View.render. Render the view based on the given `HandlerResult`.
public void	setModelKeys(Set<String> modelKeys) Set the attributes in the model that should be rendered by this view.
private <T> Mono<Void>	write(T value, MediaType contentType, ServerWebExchange exchange)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

canWriteMap	back to summary
private final boolean canWriteMap

modelKeys	back to summary
private final Set<String> modelKeys

writer	back to summary
private final HttpMessageWriter<?> writer

HttpMessageWriterView	back to summary
public HttpMessageWriterView(Encoder<?> encoder) Constructor with an `Encoder`.

HttpMessageWriterView	back to summary
public HttpMessageWriterView(HttpMessageWriter<?> writer) Constructor with a fully initialized `HttpMessageWriter`.

Method Detail

getMessageWriter	back to summary
public HttpMessageWriter<?> getMessageWriter() Return the configured message writer.

getModelKeys	back to summary
public final Set<String> getModelKeys() Return the configured model keys.

getObjectToRender	back to summary
private Object getObjectToRender(Map<String, ?> model) Annotations @Nullable

getSupportedMediaTypes back to summary

getSupportedMediaTypes	back to summary
public List<MediaType> getSupportedMediaTypes() Overrides default org.springframework.web.reactive.result.view.View.getSupportedMediaTypes. Doc from org.springframework.web.reactive.result.view.View.getSupportedMediaTypes. Return the list of media types this View supports, or an empty list. The implementation of this method for `HttpMessageWriterView` delegates to `HttpMessageWriter#getWritableMediaTypes()`. Annotations @Override

public List<MediaType> getSupportedMediaTypes()

Overrides default org.springframework.web.reactive.result.view.View.getSupportedMediaTypes.

Doc from org.springframework.web.reactive.result.view.View.getSupportedMediaTypes.

Return the list of media types this View supports, or an empty list.

The implementation of this method for HttpMessageWriterView delegates to HttpMessageWriter#getWritableMediaTypes().

Annotations

@Override

isMatch	back to summary
private boolean isMatch(Map.Entry<String, ?> entry)

render back to summary

render	back to summary
public Mono<Void> render(Map<String, ?> model, MediaType contentType, ServerWebExchange exchange) Implements org.springframework.web.reactive.result.view.View.render. Doc from org.springframework.web.reactive.result.view.View.render. Render the view based on the given `HandlerResult`. Implementations can access and use the model or only a specific attribute in it. Parameters model:Map<String, ?> a Map with name Strings as keys and corresponding model objects as values (Map can also be `null` in case of empty model) contentType:MediaType the content type selected to render with which should match one of the `supported media types`. exchange:ServerWebExchange the current exchange Returns:Mono<Void> `Mono` to represent when and if rendering succeeds Annotations @Override @SuppressWarnings:unchecked

public Mono<Void> render(Map<String, ?> model, MediaType contentType, ServerWebExchange exchange)

Implements org.springframework.web.reactive.result.view.View.render.

Doc from org.springframework.web.reactive.result.view.View.render.

Render the view based on the given HandlerResult. Implementations can access and use the model or only a specific attribute in it.

Parameters

model:Map<String, ?>: a Map with name Strings as keys and corresponding model objects as values (Map can also be null in case of empty model)
contentType:MediaType: the content type selected to render with which should match one of the supported media types.
exchange:ServerWebExchange: the current exchange

Returns:Mono<Void>

Mono to represent when and if rendering succeeds

Annotations

@Override
@SuppressWarnings:unchecked

setModelKeys back to summary

setModelKeys	back to summary
public void setModelKeys(Set<String> modelKeys) Set the attributes in the model that should be rendered by this view. When set, all other model attributes will be ignored. The matching attributes are further narrowed with `HttpMessageWriter#canWrite`. The matching attributes are processed as follows: 0: nothing is written to the response body. 1: the matching attribute is passed to the writer. 2..N: if the writer supports `Map`, write all matches; otherwise raise an `IllegalStateException`.

public void setModelKeys(Set<String> modelKeys)

Set the attributes in the model that should be rendered by this view. When set, all other model attributes will be ignored. The matching attributes are further narrowed with HttpMessageWriter#canWrite. The matching attributes are processed as follows:

0: nothing is written to the response body.
1: the matching attribute is passed to the writer.
2..N: if the writer supports Map, write all matches; otherwise raise an IllegalStateException.

write	back to summary
private <T> Mono<Void> write(T value, MediaType contentType, ServerWebExchange exchange) Annotations @SuppressWarnings:unchecked

public Class HttpMessageWriterView

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail