Add @Since 5.0 and package-info for reactive classes
This commit is contained in:
@@ -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> {
|
||||
|
||||
|
||||
@@ -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> {
|
||||
|
||||
|
||||
@@ -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> {
|
||||
|
||||
|
||||
@@ -30,6 +30,7 @@ import org.springframework.util.MimeTypeUtils;
|
||||
/**
|
||||
* @author Sebastien Deleuze
|
||||
* @author Arjen Poutsma
|
||||
* @since 5.0
|
||||
*/
|
||||
public class ByteBufferDecoder extends AbstractDecoder<ByteBuffer> {
|
||||
|
||||
|
||||
@@ -29,6 +29,7 @@ import org.springframework.util.MimeTypeUtils;
|
||||
|
||||
/**
|
||||
* @author Sebastien Deleuze
|
||||
* @since 5.0
|
||||
*/
|
||||
public class ByteBufferEncoder extends AbstractEncoder<ByteBuffer> {
|
||||
|
||||
|
||||
@@ -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 {
|
||||
|
||||
@@ -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> {
|
||||
|
||||
|
||||
@@ -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> {
|
||||
|
||||
|
||||
@@ -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> {
|
||||
|
||||
|
||||
@@ -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> {
|
||||
|
||||
|
||||
@@ -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> {
|
||||
|
||||
@@ -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> {
|
||||
|
||||
@@ -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;
|
||||
|
||||
@@ -28,6 +28,7 @@ import org.springframework.core.convert.converter.GenericConverter;
|
||||
|
||||
/**
|
||||
* @author Sebastien Deleuze
|
||||
* @since 5.0
|
||||
*/
|
||||
public class MonoToCompletableFutureConverter implements GenericConverter {
|
||||
|
||||
|
||||
@@ -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 {
|
||||
|
||||
|
||||
@@ -25,6 +25,7 @@ import java.util.function.IntPredicate;
|
||||
* Basic abstraction over byte buffers.
|
||||
*
|
||||
* @author Arjen Poutsma
|
||||
* @since 5.0
|
||||
*/
|
||||
public interface DataBuffer {
|
||||
|
||||
|
||||
@@ -24,6 +24,7 @@ import java.nio.ByteBuffer;
|
||||
*
|
||||
* @author Arjen Poutsma
|
||||
* @see DataBuffer
|
||||
* @since 5.0
|
||||
*/
|
||||
public interface DataBufferFactory {
|
||||
|
||||
|
||||
@@ -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 {
|
||||
|
||||
@@ -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 {
|
||||
|
||||
|
||||
@@ -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 {
|
||||
|
||||
@@ -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 {
|
||||
|
||||
|
||||
@@ -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
|
||||
*/
|
||||
|
||||
@@ -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 {
|
||||
|
||||
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
* Generic abstraction for working with byte buffer implementations.
|
||||
*/
|
||||
package org.springframework.core.io.buffer;
|
||||
@@ -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 {
|
||||
|
||||
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
* Support classes for Spring's byte buffer abstraction.
|
||||
*/
|
||||
package org.springframework.core.io.buffer.support;
|
||||
@@ -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) {
|
||||
|
||||
@@ -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 {
|
||||
|
||||
|
||||
@@ -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 {
|
||||
|
||||
|
||||
Reference in New Issue
Block a user