org.relayirc.chatengine
Class ChannelEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--org.relayirc.chatengine.ChannelEvent

All Implemented Interfaces:

java.io.Serializable

public class ChannelEvent

extends java.util.EventObject

Event fired by a channel. The source of a ChannelEvent is always a Channel object.

Author:

David M. Johnson

The contents of this file are subject to the Mozilla Public License Version 1.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.mozilla.org/MPL/

Original Code: Relay IRC Chat Engine
Initial Developer: David M. Johnson
Contributor(s): No contributors to this file
Copyright (C) 1997-2000 by David M. Johnson
All Rights Reserved.

See Also:

Channel, ChannelListener, Serialized Form

Fields inherited from class java.util.EventObject

source

Constructor Summary

ChannelEvent(Channel src)
Event with no associated values.

ChannelEvent(Channel src, java.lang.Object value)
Event with an optional arbitrary value.

ChannelEvent(Channel src, java.lang.String originNick, java.lang.String originAddress, java.lang.Object value)
Event with originating user and an optional arbitrary value.

ChannelEvent(Channel src, java.lang.String originNick, java.lang.String originAddress, java.lang.String subjectNick, java.lang.String subjectAddress, java.lang.Object value)
Event with originating user, destination user and an optional arbitrary value.

Method Summary

java.lang.String	getOriginAddress() Address of the originating chat user or null if not applicable.
java.lang.String	getOriginNick() Nick name of the originating chat user or null if not applicable.
java.lang.String	getSubjectAddress() Address of the destination chat user or null if not applicable.
java.lang.String	getSubjectNick() Nick name of the chat user or null if not applicable.
java.lang.Object	getValue() Arbitrary value associated with event.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ChannelEvent

public ChannelEvent(Channel src)

Event with no associated values.

ChannelEvent

public ChannelEvent(Channel src,
                    java.lang.Object value)

Event with an optional arbitrary value.

ChannelEvent

public ChannelEvent(Channel src,
                    java.lang.String originNick,
                    java.lang.String originAddress,
                    java.lang.Object value)

Event with originating user and an optional arbitrary value.

ChannelEvent

public ChannelEvent(Channel src,
                    java.lang.String originNick,
                    java.lang.String originAddress,
                    java.lang.String subjectNick,
                    java.lang.String subjectAddress,
                    java.lang.Object value)

Event with originating user, destination user and an optional arbitrary value.

Method Detail

getOriginNick

public java.lang.String getOriginNick()

Nick name of the originating chat user or null if not applicable.

getOriginAddress

public java.lang.String getOriginAddress()

Address of the originating chat user or null if not applicable.

getSubjectNick

public java.lang.String getSubjectNick()

Nick name of the chat user or null if not applicable.

getSubjectAddress

public java.lang.String getSubjectAddress()

Address of the destination chat user or null if not applicable.

getValue

public java.lang.Object getValue()

Arbitrary value associated with event.