com.sun.media.jsdt.event
Class ChannelEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--com.sun.media.jsdt.event.ChannelEvent

public class ChannelEvent
extends java.util.EventObject
implements com.sun.media.jsdt.impl.JSDTDebugFlags

The Channel event. Channel events are created for the following actions:

 - when a Client has joined a Channel.
 - when a Client has left a Channel.
 - when a Client has been invited to join a Channel.
 - when a Client has been expelled from a Channel.
 - when a Client has added a Consumer to the Channel.
 - when a Client has removed a Consumer from the Channel.
 

Since:
JSDT 1.0
Version:
1.5 - 7th January 1999
Author:
Rich Burridge
See Also:
Serialized Form

Field Summary
protected  Channel channel
          The channel this event occured on.
static int CONSUMER_ADDED
          The Channel consumer added event type.
static int CONSUMER_REMOVED
          The Channel consumer removed event type.
static int EXPELLED
          The Channel expelled event type.
static int INVITED
          The Channel invited event type.
static int JOINED
          The Channel joined event type.
static int LEFT
          The Channel left event type.
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
ChannelEvent(Session session, java.lang.String clientName, Channel channel, int type)
           constructor for the ChannelEvent class.
 
Method Summary
 Channel getChannel()
           get the Channel associated with this event.
 java.lang.String getClientName()
           get the name of the Client that generated this event.
 Session getSession()
           get the Session associated with this event.
 java.lang.String toString()
           toString print a short description of this Channel event.
 
Methods inherited from class java.util.EventObject
getSource
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

JOINED

public static final int JOINED
The Channel joined event type.

LEFT

public static final int LEFT
The Channel left event type.

INVITED

public static final int INVITED
The Channel invited event type.

EXPELLED

public static final int EXPELLED
The Channel expelled event type.

CONSUMER_ADDED

public static final int CONSUMER_ADDED
The Channel consumer added event type.

CONSUMER_REMOVED

public static final int CONSUMER_REMOVED
The Channel consumer removed event type.

channel

protected Channel channel
The channel this event occured on.
Constructor Detail

ChannelEvent

public ChannelEvent(Session session,
                    java.lang.String clientName,
                    Channel channel,
                    int type)
constructor for the ChannelEvent class. A new channel event is generated for a client action for a specific channel.
Parameters:
session - the session this channel belongs to.
clientName - the name of the client.
channel - the channel.
type - the type of event.
Method Detail

getSession

public Session getSession()
get the Session associated with this event.
Returns:
the Session associated with this event.

getClientName

public java.lang.String getClientName()
get the name of the Client that generated this event.
Returns:
the name of the Client that generated this event.

getChannel

public Channel getChannel()
get the Channel associated with this event.
Returns:
the Channel associated with this event.

toString

public java.lang.String toString()
toString print a short description of this Channel event.
Returns:
a String containing a description of this Channel event.
Overrides:
toString in class java.util.EventObject
Since:
JSDT 1.3