接口 HttpMessageWriter<T>

方法详细资料

• getWritableMediaTypes

  List<MediaType> getWritableMediaTypes()

  Return the MediaType's that this writer supports.

• canWrite

  boolean canWrite​(ResolvableType elementType,
                   @Nullable
                   MediaType mediaType)

  Whether the given object type is supported by this writer.

  参数:

  elementType - the type of object to check

  mediaType - the media type for the write (possibly null)

  返回:

  true if writable, false otherwise

• write

  reactor.core.publisher.Mono<Void> write​(org.reactivestreams.Publisher<? extends T> inputStream,
                                          ResolvableType elementType,
                                          @Nullable
                                          MediaType mediaType,
                                          ReactiveHttpOutputMessage message,
                                          Map<String,​Object> hints)

  Write an given stream of object to the output message.

  参数:

  inputStream - the objects to write

  elementType - the type of objects in the stream which must have been previously checked via canWrite(ResolvableType, MediaType)

  mediaType - the content type for the write (possibly null to indicate that the default content type of the writer must be used)

  message - the message to write to

  hints - additional information about how to encode and write

  返回:

  indicates completion or error

• write

  default reactor.core.publisher.Mono<Void> write​(org.reactivestreams.Publisher<? extends T> inputStream,
                                                  ResolvableType actualType,
                                                  ResolvableType elementType,
                                                  @Nullable
                                                  MediaType mediaType,
                                                  ServerHttpRequest request,
                                                  ServerHttpResponse response,
                                                  Map<String,​Object> hints)

  Server-side only alternative to write(Publisher, ResolvableType, MediaType, ReactiveHttpOutputMessage, Map) with additional context available.

  参数:

  actualType - the actual return type of the method that returned the value; for annotated controllers, the MethodParameter can be accessed via ResolvableType.getSource().

  elementType - the type of Objects in the input stream

  mediaType - the content type to use (possibly null indicating the default content type of the writer should be used)

  request - the current request

  response - the current response

  返回:

  a Mono that indicates completion of writing or error