oracle.ide.usages

Class UsagesTracker

java.lang.Object

oracle.ide.usages.UsagesTracker

public abstract class UsagesTracker
extends java.lang.Object

This class provides support for tracking information about how users use the product. It can be used to track system information, like product or JDK version, for example, or it can be used to track command invocations or editor changes.

To track a particular usage do:

   UsagesTracker tracker = UsagesTracker.getUsagesTracker();
   UsageData usage = tracker.createUsageData();
   usage.setEventId("CREATE_DOCUMENT");
   usage.setEventSource(wizard.getClassName());
   usage.setProperty("wizard-label", wizard.getLabel());
    ...
   tracker.report(usage);
 

Field Summary

Fields

Modifier and Type	Field and Description
protected static boolean	_isOn

Constructor Summary

Constructors

Constructor and Description
UsagesTracker()

Method Summary

Modifier and Type	Method and Description
abstract UsageData	createUsageData() Creates a UsageData object where information about feature usage can be stored.
static UsagesTracker	getUsagesTracker()
abstract void	initTracker() This method should be called once when the IDE starts up and should not be called again.
static boolean	isOn()
abstract void	report(UsageData usageData) Logs the usage data.

Methods inherited from class java.lang.Object

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

Field Detail

_isOn

protected static boolean _isOn

Constructor Detail

UsagesTracker

public UsagesTracker()

Method Detail

getUsagesTracker

public static UsagesTracker getUsagesTracker()

isOn

public static boolean isOn()

createUsageData

public abstract UsageData createUsageData()

Creates a UsageData object where information about feature usage can be stored.

Returns:

a UsageData object

report

public abstract void report(UsageData usageData)

Logs the usage data. Logs are sent to the server periodically.

Parameters:

usageData - a UsageData object; must not be null

initTracker

public abstract void initTracker()

This method should be called once when the IDE starts up and should not be called again.