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

Mark IdleStateEvent as final and add javadocs

Browse Source
This commit is contained in:
Norman Maurer 2012-12-20 15:45:35 +01:00
parent 43d13064d1
commit a1baeeb8c0
1 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
handler/src/main/java/io/netty/handler/timeout/IdleStateEvent.java
View File

@ -23,12 +23,19 @@ import io.netty.channel.Channel;
* @apiviz.landmark
* @apiviz.has io.netty.handler.timeout.IdleState oneway - -
*/
public class IdleStateEvent {
public final class IdleStateEvent {
private final IdleState state;
private final int count;
private final long durationMillis;
/**
* Create a new instance
*
* @param state the detailed idle state.
* @param count the count how often this kind of {@IdleStateEvent} was fired before
* @param durationMillis the duration which caused the {@link IdleStateEvent} to get fired in milliseconds
*/
public IdleStateEvent(IdleState state, int count, long durationMillis) {
if (state == null) {
throw new NullPointerException("state");
@ -53,10 +60,16 @@ public class IdleStateEvent {
return state;
}
/**
* Return the count how often this kind of {@IdleStateEvent} was fired before.
*/
public int count() {
return count;
}
/**
* Return the duration which caused the {@link IdleStateEvent} to get fired in milliseconds.
*/
public long durationMillis() {
return durationMillis;
}