oracle.ide.usages
Class UsageData

java.lang.Object
  oracle.javatools.data.HashStructureAdapter
      oracle.ide.usages.UsageData

public class UsageData
extends HashStructureAdapter

The base object to use to store information about feature usage.

Field Summary

Fields inherited from class oracle.javatools.data.HashStructureAdapter

_hash

Constructor Summary

protected

UsageData(HashStructure hash)

Method Summary

void	setExtensionId(java.lang.String extensionProductId) Associates an extension or product ID with this UsageData.
void	setPropertyId(java.lang.String propertyId) For property-change usages, stores a property name or id with this UsageData.
void	setPropertyValue(java.lang.String propertyValue) For property-change usages, stores a property value with this UsageData.
void	setUsageTimeStamp(java.lang.Long time) Sets the time stamp indicating when this usage occurred.
void	setUsageType(java.lang.String usageType) Stores a key that identifies the type of usage being described.

Methods inherited from class oracle.javatools.data.HashStructureAdapter

addStructureChangeListener, containsKey, copyTo, copyToImpl, equals, equalsImpl, findOrCreate, forcedCopyTo, getHashStructure, removeStructureChangeListener, useObjectEquals

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UsageData

protected UsageData(HashStructure hash)

Method Detail

setUsageType

public final void setUsageType(java.lang.String usageType)

Stores a key that identifies the type of usage being described.

Parameters:

usageType - the usage type; should not be null

setExtensionId

public final void setExtensionId(java.lang.String extensionProductId)

Associates an extension or product ID with this UsageData.

Parameters:

extensionProductId - the extension or product identifier; must not be null

setPropertyId

public final void setPropertyId(java.lang.String propertyId)

For property-change usages, stores a property name or id with this UsageData.

Parameters:

propertyId - the property id

setPropertyValue

public final void setPropertyValue(java.lang.String propertyValue)

For property-change usages, stores a property value with this UsageData.

Parameters:

propertyValue - the property id

setUsageTimeStamp

public final void setUsageTimeStamp(java.lang.Long time)

Sets the time stamp indicating when this usage occurred. The time stamp is stored automatically when a usage is reported.

Parameters:

time - the time as a Long; must not be null

See Also:

UsagesTracker.report(oracle.ide.usages.UsageData)