com.starbase.starteam
Class EventHandlerInfo

java.lang.Object
  |
  +--com.starbase.starteam.EventHandlerInfo

public class EventHandlerInfo

extends java.lang.Object

The EventHandlerInfo class describes a registered event handler, such as the one for the StarTeam MPX Server.

Field Summary

static java.lang.String

MPX_TRANSMITTER Deprecated.

Method Summary

void	addProfile(EventHandlerProfile profile) Add an EventHandlerProfile to this EventHandlerInfo object.
void	deleteProfile(EventHandlerProfile profile) Remove an EventHandlerProfile from this EventHandlerInfo object.
boolean	equals(java.lang.Object source) returns true if this object instance is equal to the source
java.lang.String	getDescription() Gets the description of this EventHandlerInfo.
java.lang.String	getName() Gets the name of this EventHandlerInfo.
EventHandlerProfile	getProfile(java.lang.String profileName) Returns the specified EventHandlerProfile object.
java.lang.String[]	getProfileNames() Returns an array containing the names of all existing EventHandlerProfiles of this EventHandlerInfo.
java.lang.Object	getProperty(java.lang.String propertyName) Gets the value of a named property.
java.lang.String[]	getPropertyNames() Gets the names of all existing properties of this EventHandlerInfo.
int	hashCode() returns a unique hash for all instances of this type
java.lang.Object	putProperty(java.lang.String propertyName, java.lang.Object value) Sets the value of the named property.
java.lang.Object	removeProperty(java.lang.String propertyName) Removes the named property.
void	setDescription(java.lang.String description) Sets the description of this EventHandlerInfo.
java.lang.String	toString() Returns a summary String representation of this object.
void	update() Stores the existing EventHandlerInfo in the server.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

MPX_TRANSMITTER

public static final java.lang.String MPX_TRANSMITTER

Deprecated.

The name of the event handler for the StarTeam MPX Transmitter. Pass this name to Server.getEventHandlerInfo() to get the event handler information for the MPX event transmitter. Pre-9.0 servers use the name "StarbaseMPX Transmitter" 9.0 servers use the name "StarTeamMPX Transmitter"

See Also:

Server.getMPXTransmitterName(), Constant Field Values

Method Detail

update

public void update()

Stores the existing EventHandlerInfo in the server.

getProfileNames

public java.lang.String[] getProfileNames()

Returns an array containing the names of all existing EventHandlerProfiles of this EventHandlerInfo.

Returns:

an array containing the names of all existing EventHandlerProfiles of this EventHandlerInfo

getProfile

public EventHandlerProfile getProfile(java.lang.String profileName)

Returns the specified EventHandlerProfile object. If no such EventhandlerProfile exist, a null is returned.

Parameters:

profileName - the name of the EventHandlerInfo object to be returned

Returns:

the specified EventHandlerProfile object. If no such EventhandlerProfile exist, a null is returned.

See Also:

EventHandlerInfo.getProfileNames()

addProfile

public void addProfile(EventHandlerProfile profile)

Add an EventHandlerProfile to this EventHandlerInfo object.

Parameters:

profile - the EventHandlerProfile to be added.

deleteProfile

public void deleteProfile(EventHandlerProfile profile)

Remove an EventHandlerProfile from this EventHandlerInfo object.

Parameters:

profile - the EventHandlerProfile to be removed.

getName

public java.lang.String getName()

Gets the name of this EventHandlerInfo.

Returns:

The name of this EventHandlerInfo.

getDescription

public java.lang.String getDescription()

Gets the description of this EventHandlerInfo.

Returns:

The description of this EventHandlerInfo.

setDescription

public void setDescription(java.lang.String description)

Sets the description of this EventHandlerInfo.

Parameters:

description - The description of this EventHandlerInfo.

getPropertyNames

public java.lang.String[] getPropertyNames()

Gets the names of all existing properties of this EventHandlerInfo.

Returns:

The names of all existing properties of this EventHandlerInfo.

getProperty

public java.lang.Object getProperty(java.lang.String propertyName)

Gets the value of a named property.

Parameters:

propertyName - The name of the property.

Returns:

The value of the named property.

See Also:

EventHandlerInfo.getPropertyNames()

putProperty

public java.lang.Object putProperty(java.lang.String propertyName,
                                    java.lang.Object value)

Sets the value of the named property.

Parameters:

propertyName - the name of the property.

Returns:

the old value of the named property.

See Also:

EventHandlerInfo.getPropertyNames()

removeProperty

public java.lang.Object removeProperty(java.lang.String propertyName)

Removes the named property.

Parameters:

propertyName - the name of the property.

Returns:

the old value of the named property.

See Also:

EventHandlerInfo.getPropertyNames()

toString

public java.lang.String toString()

Returns a summary String representation of this object.

Overrides:

toString in class java.lang.Object

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