Package io.micronaut.servlet.http.encoders

Class FileEncoder

java.lang.Object

io.micronaut.servlet.http.encoders.FileEncoder

All Implemented Interfaces:

ServletResponseEncoder<File>

@Singleton
public class FileEncoder
extends Object
implements ServletResponseEncoder<File>

Handles File.

Since:

1.0.0

Author:

graemerocher

Constructor Summary

Constructors

Constructor	Description
FileEncoder()
FileEncoder(@Nullable ServletConfiguration servletConfiguration)

Method Summary

Modifier and Type	Method	Description
org.reactivestreams.Publisher<io.micronaut.http.MutableHttpResponse<?>>	encode(@NonNull ServletExchange<?,?> exchange, io.micronaut.core.annotation.AnnotationMetadata annotationMetadata, @NonNull File value)	Encode the given value.
Class<File>	getResponseType()

Methods inherited from class java.lang.Object

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

Constructor Details

FileEncoder

@Inject
public FileEncoder(@Nullable
 @Nullable ServletConfiguration servletConfiguration)

FileEncoder

public FileEncoder()

Method Details

getResponseType

public Class<File> getResponseType()

Specified by:

getResponseType in interface ServletResponseEncoder<File>

Returns:

The response type.

encode

public org.reactivestreams.Publisher<io.micronaut.http.MutableHttpResponse<?>> encode(@NonNull
 @NonNull ServletExchange<?,?> exchange,
 io.micronaut.core.annotation.AnnotationMetadata annotationMetadata,
 @NonNull
 @NonNull File value)

Description copied from interface: ServletResponseEncoder

Encode the given value.

Specified by:

encode in interface ServletResponseEncoder<File>

Parameters:

exchange - The change

annotationMetadata - The annotation metadata declared on the method

value - The value to encode

Returns:

A publisher that emits completes with the response once the value has been encoded