com.starteam
Class EventHandlerProfile

java.lang.Object
  com.starteam.EventHandlerProfile

public final class EventHandlerProfile
extends java.lang.Object

The EventHandlerProfile class contains the information of one of profiles of an EventHandlerInfo.

Constructor Summary

EventHandlerProfile(java.lang.String name, java.lang.String description)
Constructs a new Event Handler Profile object.

Method Summary

EventHandlerProfile	copy() Creates a copy of this EventHandlerProfile.
java.lang.String	getDescription() Gets the description of this EventHandlerProfile.
java.lang.String	getName() Gets the name of this EventHandlerProfile.
java.lang.Object	getProperty(java.lang.String propertyName) Gets the value of the named property.
java.lang.String[]	getPropertyNames() Gets the names of all existing properties of this EventHandlerProfile.
boolean	isEqualTo(EventHandlerProfile p) Compares two EventHandlerProfile objects.
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 EventHandlerProfile.
java.lang.String	toString()
void	update() Stores the existing EventHandlerProfile in the server.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

EventHandlerProfile

public EventHandlerProfile(java.lang.String name,
                           java.lang.String description)

Constructs a new Event Handler Profile object. The object returned needs to be added to an EventHandlerInfo by calling EventHandlerInfo.addProfile() before being stored.

Parameters:

name - the name of the profile

description - the description of the profile

See Also:

EventHandlerInfo.addProfile(com.starteam.EventHandlerProfile)

Method Detail

copy

public EventHandlerProfile copy()

Creates a copy of this EventHandlerProfile. Copies the Name, Description, all the individual properties, and their associated values.

Returns:

A new copy of this EventHandlerProfile.

See Also:

EventHandlerProfile.isEqualTo(com.starteam.EventHandlerProfile)

isEqualTo

public boolean isEqualTo(EventHandlerProfile p)

Compares two EventHandlerProfile objects. Compares the Name, Description, all the individual properties, and their associated values.

Parameters:

p - The EventHandlerProfile object to be compared to this one.

Returns:

true if no differences were found.

See Also:

EventHandlerProfile.copy()

update

public void update()

Stores the existing EventHandlerProfile in the server. If the EventHandlerProfile is new, EventHandlerInfo.addProfile() should be called instead.

See Also:

EventHandlerInfo.addProfile(com.starteam.EventHandlerProfile)

getName

public java.lang.String getName()

Gets the name of this EventHandlerProfile.

Returns:

The name of this EventHandlerProfile.

getDescription

public java.lang.String getDescription()

Gets the description of this EventHandlerProfile.

Returns:

The description of this EventHandlerProfile.

setDescription

public void setDescription(java.lang.String description)

Sets the description of this EventHandlerProfile.

Parameters:

description - The description of this EventHandlerProfile.

getPropertyNames

public java.lang.String[] getPropertyNames()

Gets the names of all existing properties of this EventHandlerProfile.

Returns:

The names of all existing properties of this EventHandlerProfile.

getProperty

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

Gets the value of the named property.

Parameters:

propertyName - The name of the property.

Returns:

The value of the named property.

See Also:

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

value - The new value of the property.

Returns:

The old value of the named property.

See Also:

EventHandlerProfile.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:

EventHandlerProfile.getPropertyNames()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.