Add @Since 5.0 and package-info for reactive classes

This commit is contained in:
Rossen Stoyanchev
2016-07-14 17:39:32 -04:00
parent e2c7653da4
commit d2e105f28d
204 changed files with 266 additions and 32 deletions

View File

@@ -30,6 +30,7 @@ import org.springframework.util.MimeType;
/**
* @author Sebastien Deleuze
* @author Arjen Poutsma
* @since 5.0
*/
public abstract class AbstractDecoder<T> implements Decoder<T> {

View File

@@ -26,6 +26,7 @@ import org.springframework.util.MimeType;
/**
* @author Sebastien Deleuze
* @author Arjen Poutsma
* @since 5.0
*/
public abstract class AbstractEncoder<T> implements Encoder<T> {

View File

@@ -28,6 +28,7 @@ import org.springframework.util.MimeType;
* Abstract base class for {@link org.springframework.core.codec.Encoder} classes that
* can only deal with a single value.
* @author Arjen Poutsma
* @since 5.0
*/
public abstract class AbstractSingleValueEncoder<T> extends AbstractEncoder<T> {

View File

@@ -30,6 +30,7 @@ import org.springframework.util.MimeTypeUtils;
/**
* @author Sebastien Deleuze
* @author Arjen Poutsma
* @since 5.0
*/
public class ByteBufferDecoder extends AbstractDecoder<ByteBuffer> {

View File

@@ -29,6 +29,7 @@ import org.springframework.util.MimeTypeUtils;
/**
* @author Sebastien Deleuze
* @since 5.0
*/
public class ByteBufferEncoder extends AbstractEncoder<ByteBuffer> {

View File

@@ -22,6 +22,7 @@ import org.springframework.core.NestedRuntimeException;
* Codec related exception, usually used as a wrapper for a cause exception.
*
* @author Sebastien Deleuze
* @since 5.0
*/
@SuppressWarnings("serial")
public class CodecException extends NestedRuntimeException {

View File

@@ -33,6 +33,7 @@ import org.springframework.util.MimeType;
* @author Sebastien Deleuze
* @author Rossen Stoyanchev
* @param <T> the type of elements in the output stream
* @since 5.0
*/
public interface Decoder<T> {

View File

@@ -33,6 +33,7 @@ import org.springframework.util.MimeType;
* @author Sebastien Deleuze
* @author Rossen Stoyanchev
* @param <T> the type of elements in the input stream
* @since 5.0
*/
public interface Encoder<T> {

View File

@@ -35,6 +35,7 @@ import org.springframework.util.MimeTypeUtils;
* A decoder for {@link Resource}s.
*
* @author Arjen Poutsma
* @since 5.0
*/
public class ResourceDecoder extends AbstractDecoder<Resource> {

View File

@@ -34,6 +34,7 @@ import org.springframework.util.StreamUtils;
/**
* An encoder for {@link Resource}s.
* @author Arjen Poutsma
* @since 5.0
*/
public class ResourceEncoder extends AbstractSingleValueEncoder<Resource> {

View File

@@ -44,6 +44,7 @@ import org.springframework.util.MimeTypeUtils;
* @author Brian Clozel
* @author Arjen Poutsma
* @author Mark Paluch
* @since 5.0
* @see StringEncoder
*/
public class StringDecoder extends AbstractDecoder<String> {

View File

@@ -31,6 +31,7 @@ import org.springframework.util.MimeType;
* Encode from a String stream to a bytes stream.
*
* @author Sebastien Deleuze
* @since 5.0
* @see StringDecoder
*/
public class StringEncoder extends AbstractEncoder<String> {

View File

@@ -1,6 +1,6 @@
/**
* Provides {@link org.springframework.core.codec.Encoder} and
* {@link org.springframework.core.codec.Decoder} abstractions for converting
* to and from between a stream of bytes and a stream of Java objects.
* {@link org.springframework.core.codec.Encoder} and
* {@link org.springframework.core.codec.Decoder} abstractions to convert
* between a reactive stream of bytes and Java objects.
*/
package org.springframework.core.codec;

View File

@@ -28,6 +28,7 @@ import org.springframework.core.convert.converter.GenericConverter;
/**
* @author Sebastien Deleuze
* @since 5.0
*/
public class MonoToCompletableFutureConverter implements GenericConverter {

View File

@@ -35,6 +35,7 @@ import org.springframework.core.convert.converter.GenericConverter;
/**
* @author Stephane Maldini
* @author Sebastien Deleuze
* @since 5.0
*/
public final class ReactorToRxJava1Converter implements GenericConverter {

View File

@@ -25,6 +25,7 @@ import java.util.function.IntPredicate;
* Basic abstraction over byte buffers.
*
* @author Arjen Poutsma
* @since 5.0
*/
public interface DataBuffer {

View File

@@ -24,6 +24,7 @@ import java.nio.ByteBuffer;
*
* @author Arjen Poutsma
* @see DataBuffer
* @since 5.0
*/
public interface DataBufferFactory {

View File

@@ -33,6 +33,7 @@ import org.springframework.util.ObjectUtils;
* using the {@link DefaultDataBufferFactory}.
*
* @author Arjen Poutsma
* @since 5.0
* @see DefaultDataBufferFactory
*/
public class DefaultDataBuffer implements DataBuffer {

View File

@@ -26,6 +26,7 @@ import org.springframework.util.Assert;
* heap-based or direct buffers are to be preferred.
*
* @author Arjen Poutsma
* @since 5.0
*/
public class DefaultDataBufferFactory implements DataBufferFactory {

View File

@@ -26,6 +26,7 @@ import java.util.function.IntPredicate;
* previously buffered data should be flushed.
*
* @author Sebastien Deleuze
* @since 5.0
* @see FlushingDataBuffer#INSTANCE
*/
public class FlushingDataBuffer implements DataBuffer {

View File

@@ -36,6 +36,7 @@ import org.springframework.util.ObjectUtils;
* Typically constructed using the {@link NettyDataBufferFactory}.
*
* @author Arjen Poutsma
* @since 5.0
*/
public class NettyDataBuffer implements PooledDataBuffer {

View File

@@ -29,6 +29,7 @@ import org.springframework.util.Assert;
* {@link ByteBufAllocator}.
*
* @author Arjen Poutsma
* @since 5.0
* @see io.netty.buffer.PooledByteBufAllocator
* @see io.netty.buffer.UnpooledByteBufAllocator
*/

View File

@@ -21,6 +21,7 @@ package org.springframework.core.io.buffer;
* Introduces methods for reference counting.
*
* @author Arjen Poutsma
* @since 5.0
*/
public interface PooledDataBuffer extends DataBuffer {

View File

@@ -0,0 +1,4 @@
/**
* Generic abstraction for working with byte buffer implementations.
*/
package org.springframework.core.io.buffer;

View File

@@ -38,6 +38,7 @@ import org.springframework.util.Assert;
* Utility class for working with {@link DataBuffer}s.
*
* @author Arjen Poutsma
* @since 5.0
*/
public abstract class DataBufferUtils {

View File

@@ -0,0 +1,4 @@
/**
* Support classes for Spring's byte buffer abstraction.
*/
package org.springframework.core.io.buffer.support;

View File

@@ -327,6 +327,7 @@ public abstract class MimeTypeUtils {
* Framework.
* @param filename the filename whose mime type is to be found
* @return the mime type, if any
* @since 5.0
*/
public static Optional<MimeType> getMimeType(String filename) {
if (filename != null) {

View File

@@ -28,6 +28,7 @@ import org.springframework.util.ClassUtils;
/**
* Abstract base class for {@code XMLEventReader}s.
* @author Arjen Poutsma
* @since 5.0
*/
abstract class AbstractXMLEventReader implements XMLEventReader {

View File

@@ -27,6 +27,7 @@ import org.springframework.util.Assert;
* Implementation of {@code XMLEventReader} based on a list of {@link XMLEvent}s.
*
* @author Arjen Poutsma
* @since 5.0
*/
class ListBasedXMLEventReader extends AbstractXMLEventReader {