org.relayirc.chatengine
Class ServerEvent

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

All Implemented Interfaces:

java.io.Serializable

public class ServerEvent

extends java.util.EventObject

Event fired by a Server. Has either a Channel object, a Server object, a string status message or no value; other fields will be null.

Version:

$Revision: 1.4.2.4 $

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.

Author:

David M. Johnson.

See Also:

Serialized Form

Fields inherited from class java.util.EventObject

source

Constructor Summary

ServerEvent(Server src)
Event with no associated value.

ServerEvent(Server src, Channel channel)
Event associated with a channel.

ServerEvent(Server src, Server server)
Event associated with server.

ServerEvent(Server src, java.lang.String message)
Event associated with status message.

ServerEvent(Server src, java.lang.String[] usersOn)
Event associated with a user.

ServerEvent(Server src, java.lang.String orgnick, java.lang.String targnick, java.lang.String chan)
Invite with origin nick, target nick and channel name.

ServerEvent(Server src, User user)
Event associated with a user.

Method Summary

Channel	getChannel() Get associated Channel object, or null if not applicable.
java.lang.String	getChannelName() Get associated channel name (for onInvite), or null if not applicable.
java.lang.String	getMessage() Get associated message, or null if not applicable.
java.lang.String	getOriginNick() Get nick of user who originated this event (for onInvite), or null if not applicable.
Server	getServer() Get associated Server object, or null if not applicable.
java.lang.String	getTargetNick() Get nick of target user of this event (for onInvite), or null if not applicable.
User	getUser() Get user associated with this message, or null if not applicable.
java.lang.String[]	getUsers() Get list of user nick names (for onIsOn), or null if not applicable

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

ServerEvent

public ServerEvent(Server src)

Event with no associated value.

ServerEvent

public ServerEvent(Server src,
                   java.lang.String orgnick,
                   java.lang.String targnick,
                   java.lang.String chan)

Invite with origin nick, target nick and channel name.

ServerEvent

public ServerEvent(Server src,
                   Channel channel)

Event associated with a channel.

ServerEvent

public ServerEvent(Server src,
                   Server server)

Event associated with server.

ServerEvent

public ServerEvent(Server src,
                   User user)

Event associated with a user.

ServerEvent

public ServerEvent(Server src,
                   java.lang.String[] usersOn)

Event associated with a user.

ServerEvent

public ServerEvent(Server src,
                   java.lang.String message)

Event associated with status message. Server sends out status messages as events.

Method Detail

getChannel

public Channel getChannel()

Get associated Channel object, or null if not applicable.

getServer

public Server getServer()

Get associated Server object, or null if not applicable.

getMessage

public java.lang.String getMessage()

Get associated message, or null if not applicable.

getUser

public User getUser()

Get user associated with this message, or null if not applicable.

getUsers

public java.lang.String[] getUsers()

Get list of user nick names (for onIsOn), or null if not applicable

getOriginNick

public java.lang.String getOriginNick()

Get nick of user who originated this event (for onInvite), or null if not applicable.

getTargetNick

public java.lang.String getTargetNick()

Get nick of target user of this event (for onInvite), or null if not applicable.

getChannelName

public java.lang.String getChannelName()

Get associated channel name (for onInvite), or null if not applicable.