com.starbase.starteam
Class UserEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--com.starbase.starteam.UserEvent
All Implemented Interfaces:
java.io.Serializable

public class UserEvent
extends java.util.EventObject

An event triggered whenever a User is added, changed or deleted on the server.

See Also:
UserListener, Server.addUserListener(com.starbase.starteam.UserListener), Serialized Form

Method Summary
 boolean equals(java.lang.Object source)
          returns true if this object instance is equal to the source
 java.lang.Object getSource()
          The object on which the Event initially occurred.
 User getUser()
          Gets the User that has been added, changed or deleted, in its new state.
 int hashCode()
          returns a unique hash for all instances of this type
 java.lang.String toString()
          Gets a short description of this UserEvent.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Method Detail

getUser

public User getUser()
Gets the User that has been added, changed or deleted, in its new state.

Returns a User object that is not a member of the Server's User collection (that is, it is not among the User objects returned by Server.getUsers()). There may be a User in the collection with the same ID, but it would be a physically different object that is likely to have different properties.

If an application wants to refresh the User objects in the Server's User collection, it must explicitly call Server.refreshUsers().

Returns:
The User that has been added, changed or deleted, in its new state.
See Also:
User, Server.getUsers(), Server.refreshUsers()

getSource

public java.lang.Object getSource()
The object on which the Event initially occurred.

Overrides:
getSource in class java.util.EventObject
Returns:
The object on which the Event initially occurred.

toString

public java.lang.String toString()
Gets a short description of this UserEvent.

Overrides:
toString in class java.util.EventObject
Returns:
A short description of this UserEvent.

equals

public boolean equals(java.lang.Object source)
returns true if this object instance is equal to the source

Overrides:
equals in class java.lang.Object
Parameters:
source - Object the source to comapre with
Returns:
boolean true if this object is equal to the source

hashCode

public int hashCode()
returns a unique hash for all instances of this type

Overrides:
hashCode in class java.lang.Object
Returns:
int a unique hash for all instances of this type


StarTeam SDK 10.4, Build 36
Copyright © 2003-2008 Borland Software Corporation. All rights reserved.