andreacavalli/netty5
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Add @SupressWarnings("deprecation") to ChannelInboundHandlerAdapter and clarify deprecation in ChannelHandler (#9001)

Browse Source 
Motivation:

https://github.com/netty/netty/pull/8826 added @Deprecated to the exceptionCaught(...) method but we missed to add @SupressWarnings(...) to it's sub-types. Beside this we can make the deprecated docs a bit more clear.

Modifications:

- Add @SupressWarnings("deprecated")
- Clarify docs.

Result:

Less warnings and more clear deprecated docs.
This commit is contained in:
Norman Maurer 2019-04-02 20:52:06 +02:00 committed by GitHub
parent f8c89e2e05
commit 20042b6522
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
transport/src/main/java/io/netty/channel/ChannelHandler.java
View File

@ -191,7 +191,8 @@ public interface ChannelHandler {
/** /**
* Gets called if a {@link Throwable} was thrown. * Gets called if a {@link Throwable} was thrown.
* *
* @deprecated is part of {@link ChannelInboundHandler} * @deprecated if you want to handle this event you should implement {@link ChannelInboundHandler} and
* implement the method there.
*/ */
@Deprecated @Deprecated
void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception; void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception;

1
transport/src/main/java/io/netty/channel/ChannelInboundHandlerAdapter.java
View File

@ -126,6 +126,7 @@ public class ChannelInboundHandlerAdapter extends ChannelHandlerAdapter implemen
* Sub-classes may override this method to change behavior. * Sub-classes may override this method to change behavior.
*/ */
@Override @Override
@SuppressWarnings("deprecation")
public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause)
throws Exception { throws Exception {
ctx.fireExceptionCaught(cause); ctx.fireExceptionCaught(cause);