org.walluck.oscar.tools
Class Tool

java.lang.Object
  extended byorg.walluck.oscar.tools.Tool
Direct Known Subclasses:
AdminTool, AdvertTool, BOSTool, BuddyListTool, ChatNavTool, ChatTool, ICBMTool, IconTool, ICQTool, InviteTool, LocateTool, LoginTool, MailTool, MiscTool, ODirTool, PopupTool, ServiceTool, SSITool, StatsTool, TranslateTool, UserLookupTool

public abstract class Tool
extends java.lang.Object

The interface that all tools must implement.

Since:
1.0
Version:
1.0
Author:
David Walluck

Constructor Summary
Tool()
           
 
Method Summary
 int getFamily()
          Get the value of family.
 int getId()
          Get the value of id.
 int getVersion()
          Get the value of version.
 void setFamily(int family)
          Set the value of family.
 void setId(int id)
          Set the value of id.
 void setVersion(int version)
          Set the value of version.
abstract  void shutdown(AIMSession sess)
          Called when the tool is shutting down.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Tool

public Tool()
Method Detail

shutdown

public abstract void shutdown(AIMSession sess)
Called when the tool is shutting down.

Parameters:
sess - the oscar session

getFamily

public int getFamily()
Get the value of family.

Returns:
value of family.

setFamily

public void setFamily(int family)
Set the value of family.

Parameters:
family - Value to assign to family.

getId

public int getId()
Get the value of id.

Returns:
value of id.

setId

public void setId(int id)
Set the value of id.

Parameters:
id - Value to assign to id.

getVersion

public int getVersion()
Get the value of version.

Returns:
value of version.

setVersion

public void setVersion(int version)
Set the value of version.

Parameters:
version - Value to assign to version.