joerg/netty-http
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

javadoc fixes for Java 13

Browse source
This commit is contained in:
Jörg Prante 2020-05-20 15:18:02 +02:00
parent 57dd5fabc9
commit b0b05d95d9
5 changed files with 2 additions and 38 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
.gitignore vendored
View file

@ -10,4 +10,5 @@
/.gradle /.gradle
build build
out out
*~ *~
*.iml

8
netty-http-rx/src/main/java/io/reactivex/netty/channel/ChannelOperations.java
View file

@ -64,8 +64,6 @@ public interface ChannelOperations<W> {
/** /**
* On subscription of the returned {@link Observable}, writes the passed message stream on the underneath channel. * On subscription of the returned {@link Observable}, writes the passed message stream on the underneath channel.
* *
* <h2>Flush.</h2>
*
* All writes will be flushed on completion of the passed {@code Observable} * All writes will be flushed on completion of the passed {@code Observable}
* *
* @param msgs Stream of messages to write. * @param msgs Stream of messages to write.
@ -108,8 +106,6 @@ public interface ChannelOperations<W> {
/** /**
* On subscription of the returned {@link Observable}, writes the passed message stream on the underneath channel. * On subscription of the returned {@link Observable}, writes the passed message stream on the underneath channel.
* *
* <h2>Flush.</h2>
*
* All writes will be flushed on completion of the passed {@code Observable} * All writes will be flushed on completion of the passed {@code Observable}
* *
* @param msgs Stream of messages to write. * @param msgs Stream of messages to write.
@ -152,8 +148,6 @@ public interface ChannelOperations<W> {
/** /**
* On subscription of the returned {@link Observable}, writes the passed message stream on the underneath channel. * On subscription of the returned {@link Observable}, writes the passed message stream on the underneath channel.
* *
* <h2>Flush.</h2>
*
* All writes will be flushed on completion of the passed {@code Observable} * All writes will be flushed on completion of the passed {@code Observable}
* *
* @param msgs Stream of messages to write. * @param msgs Stream of messages to write.
@ -196,8 +190,6 @@ public interface ChannelOperations<W> {
/** /**
* On subscription of the returned {@link Observable}, writes the passed message stream on the underneath channel. * On subscription of the returned {@link Observable}, writes the passed message stream on the underneath channel.
* *
* <h2>Flush.</h2>
*
* All writes will be flushed on completion of the passed {@code Observable} * All writes will be flushed on completion of the passed {@code Observable}
* *
* @param msgs Stream of messages to write. * @param msgs Stream of messages to write.

2
netty-http-rx/src/main/java/io/reactivex/netty/channel/Connection.java
View file

@ -289,8 +289,6 @@ public abstract class Connection<R, W> implements ChannelOperations<W> {
/** /**
* Returns the underlying netty {@link Channel} for this connection. * Returns the underlying netty {@link Channel} for this connection.
* *
* <h2>Why unsafe?</h2>
*
* It is advisable to use this connection abstraction for all interactions with the channel, however, advanced users * It is advisable to use this connection abstraction for all interactions with the channel, however, advanced users
* may find directly using the netty channel useful in some cases. * may find directly using the netty channel useful in some cases.
* *

3
netty-http-rx/src/main/java/io/reactivex/netty/protocol/http/server/HttpServerResponse.java
View file

@ -300,7 +300,6 @@ public abstract class HttpServerResponse<C> extends ResponseContentWriter<C> {
/** /**
* This is a performance optimization to <em>not</em> flush the channel on every response send. * This is a performance optimization to <em>not</em> flush the channel on every response send.
* *
* <h2>When NOT to use</h2>
* This can be used * This can be used
* only when the processing for a server is not asynchronous, in which case, one would have to flush the responses * only when the processing for a server is not asynchronous, in which case, one would have to flush the responses
* written explicitly (done on completion of the {@link Observable} written). Something like this: * written explicitly (done on completion of the {@link Observable} written). Something like this:
@ -312,8 +311,6 @@ public abstract class HttpServerResponse<C> extends ResponseContentWriter<C> {
) )
</PRE> </PRE>
* *
* <h2>When to use</h2>
*
* This can be used when the response is written synchronously from a {@link RequestHandler}, something like: * This can be used when the response is written synchronously from a {@link RequestHandler}, something like:
* *
<PRE> <PRE>

24
netty-http-rx/src/main/java/io/reactivex/netty/protocol/http/server/ResponseContentWriter.java
View file

@ -38,8 +38,6 @@ public abstract class ResponseContentWriter<C> extends Observable<Void> {
/** /**
* On subscription of the returned {@link Observable}, writes the passed message stream on the underneath channel. * On subscription of the returned {@link Observable}, writes the passed message stream on the underneath channel.
* *
* <h2>Flush</h2>
*
* The writes are flushed when the passed stream completes. * The writes are flushed when the passed stream completes.
* *
* @param msgs Stream of messages to write. * @param msgs Stream of messages to write.
@ -57,14 +55,10 @@ public abstract class ResponseContentWriter<C> extends Observable<Void> {
* {@code trailerMutator} will be invoked for every item emitted from the content source, giving a chance to modify * {@code trailerMutator} will be invoked for every item emitted from the content source, giving a chance to modify
* the trailing headers instance. * the trailing headers instance.
* *
* <h2>Multiple invocations</h2>
*
* This method can <em>not</em> be invoked multiple times for the same response as on completion of the passed * This method can <em>not</em> be invoked multiple times for the same response as on completion of the passed
* source, it writes the trailing headers and trailing headers can only be written once for an HTTP response. * source, it writes the trailing headers and trailing headers can only be written once for an HTTP response.
* So, any subsequent invocation of this method will always emit an error when subscribed. * So, any subsequent invocation of this method will always emit an error when subscribed.
* *
* <h2>Flush</h2>
*
* The writes are flushed when the passed stream completes. * The writes are flushed when the passed stream completes.
* *
* @param contentSource Content source for the response. * @param contentSource Content source for the response.
@ -85,8 +79,6 @@ public abstract class ResponseContentWriter<C> extends Observable<Void> {
* {@code trailerMutator} will be invoked for every item emitted from the content source, giving a chance to modify * {@code trailerMutator} will be invoked for every item emitted from the content source, giving a chance to modify
* the trailing headers instance. * the trailing headers instance.
* *
* <h2>Multiple invocations</h2>
*
* This method can <em>not</em> be invoked multiple times for the same response as on completion of the passed * This method can <em>not</em> be invoked multiple times for the same response as on completion of the passed
* source, it writes the trailing headers and trailing headers can only be written once for an HTTP response. * source, it writes the trailing headers and trailing headers can only be written once for an HTTP response.
* So, any subsequent invocation of this method will always emit an error when subscribed. * So, any subsequent invocation of this method will always emit an error when subscribed.
@ -137,8 +129,6 @@ public abstract class ResponseContentWriter<C> extends Observable<Void> {
/** /**
* On subscription of the returned {@link Observable}, writes the passed message stream on the underneath channel. * On subscription of the returned {@link Observable}, writes the passed message stream on the underneath channel.
* *
* <h2>Flush</h2>
*
* The writes are flushed when the passed stream completes. * The writes are flushed when the passed stream completes.
* *
* @param msgs Stream of messages to write. * @param msgs Stream of messages to write.
@ -156,14 +146,10 @@ public abstract class ResponseContentWriter<C> extends Observable<Void> {
* {@code trailerMutator} will be invoked for every item emitted from the content source, giving a chance to modify * {@code trailerMutator} will be invoked for every item emitted from the content source, giving a chance to modify
* the trailing headers instance. * the trailing headers instance.
* *
* <h2>Multiple invocations</h2>
*
* This method can <em>not</em> be invoked multiple times for the same response as on completion of the passed * This method can <em>not</em> be invoked multiple times for the same response as on completion of the passed
* source, it writes the trailing headers and trailing headers can only be written once for an HTTP response. * source, it writes the trailing headers and trailing headers can only be written once for an HTTP response.
* So, any subsequent invocation of this method will always emit an error when subscribed. * So, any subsequent invocation of this method will always emit an error when subscribed.
* *
* <h2>Flush</h2>
*
* The writes are flushed when the passed stream completes. * The writes are flushed when the passed stream completes.
* *
* @param contentSource Content source for the response. * @param contentSource Content source for the response.
@ -184,8 +170,6 @@ public abstract class ResponseContentWriter<C> extends Observable<Void> {
* {@code trailerMutator} will be invoked for every item emitted from the content source, giving a chance to modify * {@code trailerMutator} will be invoked for every item emitted from the content source, giving a chance to modify
* the trailing headers instance. * the trailing headers instance.
* *
* <h2>Multiple invocations</h2>
*
* This method can <em>not</em> be invoked multiple times for the same response as on completion of the passed * This method can <em>not</em> be invoked multiple times for the same response as on completion of the passed
* source, it writes the trailing headers and trailing headers can only be written once for an HTTP response. * source, it writes the trailing headers and trailing headers can only be written once for an HTTP response.
* So, any subsequent invocation of this method will always emit an error when subscribed. * So, any subsequent invocation of this method will always emit an error when subscribed.
@ -236,8 +220,6 @@ public abstract class ResponseContentWriter<C> extends Observable<Void> {
/** /**
* On subscription of the returned {@link Observable}, writes the passed message stream on the underneath channel. * On subscription of the returned {@link Observable}, writes the passed message stream on the underneath channel.
* *
* <h2>Flush</h2>
*
* The writes are flushed when the passed stream completes. * The writes are flushed when the passed stream completes.
* *
* @param msgs Stream of messages to write. * @param msgs Stream of messages to write.
@ -255,14 +237,10 @@ public abstract class ResponseContentWriter<C> extends Observable<Void> {
* {@code trailerMutator} will be invoked for every item emitted from the content source, giving a chance to modify * {@code trailerMutator} will be invoked for every item emitted from the content source, giving a chance to modify
* the trailing headers instance. * the trailing headers instance.
* *
* <h2>Multiple invocations</h2>
*
* This method can <em>not</em> be invoked multiple times for the same response as on completion of the passed * This method can <em>not</em> be invoked multiple times for the same response as on completion of the passed
* source, it writes the trailing headers and trailing headers can only be written once for an HTTP response. * source, it writes the trailing headers and trailing headers can only be written once for an HTTP response.
* So, any subsequent invocation of this method will always emit an error when subscribed. * So, any subsequent invocation of this method will always emit an error when subscribed.
* *
* <h2>Flush</h2>
*
* The writes are flushed when the passed stream completes. * The writes are flushed when the passed stream completes.
* *
* @param contentSource Content source for the response. * @param contentSource Content source for the response.
@ -283,8 +261,6 @@ public abstract class ResponseContentWriter<C> extends Observable<Void> {
* {@code trailerMutator} will be invoked for every item emitted from the content source, giving a chance to modify * {@code trailerMutator} will be invoked for every item emitted from the content source, giving a chance to modify
* the trailing headers instance. * the trailing headers instance.
* *
* <h2>Multiple invocations</h2>
*
* This method can <em>not</em> be invoked multiple times for the same response as on completion of the passed * This method can <em>not</em> be invoked multiple times for the same response as on completion of the passed
* source, it writes the trailing headers and trailing headers can only be written once for an HTTP response. * source, it writes the trailing headers and trailing headers can only be written once for an HTTP response.
* So, any subsequent invocation of this method will always emit an error when subscribed. * So, any subsequent invocation of this method will always emit an error when subscribed.