com.starteam.events
Class CacheAgentEvent

java.lang.Object
  java.util.EventObject
      com.starteam.events.CacheAgentEvent

All Implemented Interfaces:

java.io.Serializable

public final class CacheAgentEvent
extends java.util.EventObject

An event triggered whenever content is received from a CacheAgent. Received content can consist of Object Property Values (for cache agents which cache object properties, or File Content)

See Also:

CacheAgentListener, NetMonitor.addCacheAgentListener(CacheAgentListener), Serialized Form

Method Summary

long	getBytesReceived() the number of bytes received from the Cache Agent for this item
java.lang.String	getDebugString() return a string representation of the event generally useful for application debugging
int	getExecutionTime() returns the time (in msecs) taken to process the content for this item
boolean	getIsFileContent() returns true if the content is file specific, false otherwise
boolean	getIsObjectPropertyContent() returns true if the content describes properties of cached objects, false otherwise
int	getItemID() returns the item id of the StarTeam item whose content has been received
PropertyCollection	getMissingProperties() returns the set of properties that were requested but not received from the Cache Agent NULL if file content was retrieved from the cache agent an empty property array if no properties were missed
Type	getType() returns the type of the StarTeam item whose content has been received
java.lang.String	toString() return a string representation of the event generally useful for application debugging

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Method Detail

getIsObjectPropertyContent

public boolean getIsObjectPropertyContent()

returns true if the content describes properties of cached objects, false otherwise

Returns:

boolean true if the content describes properties of cached objects, false otherwise

getIsFileContent

public boolean getIsFileContent()

returns true if the content is file specific, false otherwise

Returns:

boolean true if the content is file specific, false otherwise

getItemID

public int getItemID()

returns the item id of the StarTeam item whose content has been received

Returns:

ItemID the item id of the StarTeam item whose content has been received

getType

public Type getType()

returns the type of the StarTeam item whose content has been received

Returns:

Type the type of the StarTeam item whose content has been received

getBytesReceived

public long getBytesReceived()

the number of bytes received from the Cache Agent for this item

Returns:

long the number of bytes received from the Cache Agent for this item

getExecutionTime

public int getExecutionTime()

returns the time (in msecs) taken to process the content for this item

Returns:

int the time (in msecs) taken to process the content for this item

getMissingProperties

public PropertyCollection getMissingProperties()

returns the set of properties that were requested but not received from the Cache Agent NULL if file content was retrieved from the cache agent an empty property array if no properties were missed

Returns:

Property[] the set of properties that were requested but not received from the Cache Agent

getDebugString

public java.lang.String getDebugString()

return a string representation of the event generally useful for application debugging

Returns:

String a string representation of the event

toString

public java.lang.String toString()

return a string representation of the event generally useful for application debugging

Overrides:

toString in class java.util.EventObject

Returns:

String a string representation of the event