Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improve Encoder Javadoc

Browse Source
This commit is contained in:
Sebastien Deleuze
2016-09-08 13:24:05 +02:00
parent 10e157a5a2
commit d51005fbbe
1 changed files with 4 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
spring-core/src/main/java/org/springframework/core/codec/Encoder.java
View File

@@ -20,6 +20,7 @@ import java.util.List;
import org.reactivestreams.Publisher;
import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;
import org.springframework.core.ResolvableType;
import org.springframework.core.io.buffer.DataBuffer;
@@ -50,7 +51,9 @@ public interface Encoder<T> {
/**
* Encode a stream of Objects of type {@code T} into a {@link DataBuffer}
* output stream.
* @param inputStream the input stream of Objects to encode
* @param inputStream the input stream of Objects to encode. If the input should be
* encoded as a single value rather than as a stream of elements, an instance of
* {@link Mono} should be used.
* @param bufferFactory for creating output stream {@code DataBuffer}'s
* @param elementType the expected type of elements in the input stream;
* this type must have been previously passed to the {@link #canEncode}