com.starbase.starteam
Class FilterEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--com.starbase.starteam.FilterEvent

All Implemented Interfaces:

java.io.Serializable

public class FilterEvent

extends java.util.EventObject

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

See Also:

FilterListener, Type.addFilterQueryListener(com.starbase.starteam.IFilterQueryListener), Serialized Form

Method Summary

boolean	equals(java.lang.Object source) returns true if this object instance is equal to the source
Filter	getFilter() Gets the Filter that has been added, changed or deleted, in its new state.
java.lang.Object	getSource() The object on which the Event initially occurred.
int	hashCode() returns a unique hash for all instances of this type
java.lang.String	toString() Gets a short description of this Event.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getFilter

public Filter getFilter()

Gets the Filter that has been added, changed or deleted, in its new state.

Filter.getType() will return a Type whose properties are up-to-date as of the time the event was triggered. This Type object is a physically different object from the Type object used to register the event handler. (In the case where the event handler was registered with a Server object, this Type object is physically different from the corresponding Type object in the Server's Type collection.)

Furthermore, the Type's QueryInfo collection is also up-to-date as of the time the event was triggered.

If an application wants to refresh the list of filters associated with the original Type object, it must do so by explicitly calling Type.refreshFiltersAndQueries().

Returns:

The Filter that has been added, changed or deleted, in its new state.

See Also:

Filter, Type.getFilters(), Type.refreshFiltersAndQueries()

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 Event.

Overrides:

toString in class java.util.EventObject

Returns:

A short description of this Event.

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