View Javadoc
1   /*
2    * Copyright 2012 The Netty Project
3    *
4    * The Netty Project licenses this file to you under the Apache License,
5    * version 2.0 (the "License"); you may not use this file except in compliance
6    * with the License. You may obtain a copy of the License at:
7    *
8    *   http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13   * License for the specific language governing permissions and limitations
14   * under the License.
15   */
16  package org.jboss.netty.channel;
17  
18  
19  /**
20   * A {@link ChannelEvent} which represents the change of the {@link Channel}
21   * state.  It can mean the notification of a change or the request for a
22   * change, depending on whether it is an upstream event or a downstream event
23   * respectively.  Please refer to the {@link ChannelEvent} documentation to
24   * find out what an upstream event and a downstream event are and what
25   * fundamental differences they have.
26   *
27   * @apiviz.has org.jboss.netty.channel.ChannelState
28   */
29  public interface ChannelStateEvent extends ChannelEvent {
30  
31      /**
32       * Returns the changed property of the {@link Channel}.
33       */
34      ChannelState getState();
35  
36      /**
37       * Returns the value of the changed property of the {@link Channel}.
38       * Please refer to {@link ChannelState} documentation to find out the
39       * allowed values for each property.
40       */
41      Object getValue();
42  }