| Modifier and Type | Class and Description |
|---|---|
| public static interface | |
| public static interface | |
| public static interface | |
| public class | |
| public static interface | |
| public static interface | |
| public class | |
| public static interface | |
| public static interface | |
| public static interface | |
| public class |
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public static void |
| TimerAnnotationHelper | back to summary |
|---|---|
| public TimerAnnotationHelper() | |
| registerTimerClasses | back to summary |
|---|---|
| public static void registerTimerClasses(ManagedObjectManager mom) | |
| Modifier and Type | Method and Description |
|---|---|
| public Set | contents()
Redeclares org. Return an unmodifiable set of the contents of this Controllable. |
| public String | description()
Redeclares org. A longer description giving some details of the meaning of this Controllable. |
| public void | |
| public void | |
| public int | |
| public boolean | isEnabled()
Redeclares org. Return true if enable() was called, otherwise false if enable() was never called, or disable() was last called. |
| contents | back to summary |
|---|---|
| public Set Redeclares org. Doc from org. Return an unmodifiable set of the contents of this Controllable. May always be empty for some subclasses of Controllable.
| |
| description | back to summary |
|---|---|
| public String description() Redeclares org. Doc from org. A longer description giving some details of the meaning of this Controllable.
| |
| disable | back to summary |
|---|---|
| public void disable() Redeclares org. Doc from org. Disable this controllable.
| |
| enable | back to summary |
|---|---|
| public void enable() Redeclares org. Doc from org. Enable this controllable. All Timers that are either enabled, or reachable via contents() from an enabled Controllable are activated, and will cause TimerEvents to be generated when passed to the TimerEventController enter and exit methods.
| |
| id | back to summary |
|---|---|
| public int id() Redeclares org. Doc from org. A small id for this controllable. Each controllable created from the same TimerFactory will have a unique ID. All ids will be small integers starting at 0 (so indexing tables by timer ID is supported).
| |
| isEnabled | back to summary |
|---|---|
| public boolean isEnabled() Redeclares org. Doc from org. Return true if enable() was called, otherwise false if enable() was never called, or disable() was last called.
| |
| Modifier and Type | Method and Description |
|---|---|
| public void | clear()
Redeclares org. Discard the contents of the log. |
| clear | back to summary |
|---|---|
| public void clear() Redeclares org. Doc from org. Discard the contents of the log.
| |
| Modifier and Type | Method and Description |
|---|---|
| public TimerFactory | factory()
Redeclares org. Return the TimerFactory that created this Named. |
| public String |
| factory | back to summary |
|---|---|
| public TimerFactory factory() Redeclares org. Doc from org. Return the TimerFactory that created this Named.
| |
| name | back to summary |
|---|---|
| public String name() Redeclares org. Doc from org. A short name for this Controllable.
| |
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public double | average()
Overrides org. Return the current average of the data, or -1 if there is no data. |
| public long | count()
Overrides org. Return the number of data points recorded. |
| public double | max()
Overrides org. Return the maximum value of call data points records. |
| public double | min()
Overrides org. Return the minimum value of call data points records. |
| public double | standardDeviation()
Overrides org. Return the standard deviation of the data, or -1 if there is no data. |
| ManagedStatistics | back to summary |
|---|---|
| public ManagedStatistics(long count, double min, double max, double average, double standardDeviation) | |
| average | back to summary |
|---|---|
| public double average() Overrides org. Doc from org. Return the current average of the data, or -1 if there is no data.
| |
| count | back to summary |
|---|---|
| public long count() Overrides org. Doc from org. Return the number of data points recorded.
| |
| max | back to summary |
|---|---|
| public double max() Overrides org. Doc from org. Return the maximum value of call data points records.
| |
| min | back to summary |
|---|---|
| public double min() Overrides org. Doc from org. Return the minimum value of call data points records.
| |
| standardDeviation | back to summary |
|---|---|
| public double standardDeviation() Overrides org. Doc from org. Return the standard deviation of the data, or -1 if there is no data.
| |
| Modifier and Type | Method and Description |
|---|---|
| public void | clear()
Redeclares org. Discard all accumulated statistics. |
| public Map | stats()
Redeclares org. Return map that gives the accumulated statistics for each TimerEvent that has been observed by this event handler since the last call to clear (or since the creation of this handler, if clear has not been called). |
| clear | back to summary |
|---|---|
| public void clear() Redeclares org. Doc from org. Discard all accumulated statistics.
| |
| stats | back to summary |
|---|---|
| public Map Redeclares org. Doc from org. Return map that gives the accumulated statistics for each TimerEvent that has been observed by this event handler since the last call to clear (or since the creation of this handler, if clear has not been called).
| |
| Modifier and Type | Method and Description |
|---|---|
| public boolean | isActivated()
Redeclares org. Return true if this Timer is ready to create TimerEvents. |
| isActivated | back to summary |
|---|---|
| public boolean isActivated() Redeclares org. Doc from org. Return true if this Timer is ready to create TimerEvents. This is the case either if this Timer is enabled, or is reachable through contents() from an enabled TimerGroup.
| |
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public void | enter(Timer timer)
Overrides org. Generate a TimerEvent representing the entry to a particular timer. |
| public void | exit(Timer timer)
Overrides org. Generate a TimerEvent representing the exit from a particular timer. |
| ManagedTimerEventController | back to summary |
|---|---|
| public ManagedTimerEventController(TimerFactory factory, String name) | |
| enter | back to summary |
|---|---|
| public void enter(Timer timer) Overrides org. Doc from org. Generate a TimerEvent representing the entry to a particular timer. This event is sent to all registered TimerEventHandlers. An event is only generated in case timer.isActivated() is true.
| |
| exit | back to summary |
|---|---|
| public void exit(Timer timer) Overrides org. Doc from org. Generate a TimerEvent representing the exit from a particular timer. This event is sent to all registered TimerEventHandlers. An event is only generated in case timer.isActivated() is true.
| |
| activeSet | back to summary |
|---|---|
| public Set Redeclares org. Doc from org. Returns a read-only view of the set of Controllables that are currently active. An enabled Timer is active. All Controllables contained in an active or enabled TimerGroup are active.
| |
| enabledSet | back to summary |
|---|---|
| public Set Redeclares org. Doc from org. Returns a read-only view of the set of enabled Controllables. These have been explicitly enabled via a call to enable().
| |
| getControllable | back to summary |
|---|---|
| public Controllable getControllable(int id) Redeclares org. Doc from org. Returns the Controllable corresponding to id, for id in the range 0 (inclusive) to numberOfIds() (exclusive).
| |
| makeController | back to summary |
|---|---|
| public TimerEventController makeController(String name) Redeclares org. Doc from org. Create a TimerController, which can create TimerEvents and send them to registered TimerEventHandlers.
| |
| makeLogEventHandler | back to summary |
|---|---|
| public LogEventHandler makeLogEventHandler(String name) Redeclares org. Doc from org. Create a new LogEventHandler. All LogEventHandler names must be unique within the same TimerFactory.
| |
| makeMultiThreadedStatsEventHandler | back to summary |
|---|---|
| public StatsEventHandler makeMultiThreadedStatsEventHandler(String name) Redeclares org. Doc from org. Create a new StatsEventHandler. A StatsEventHandler records running statistics for all enter/exit pairs until it is cleared, at which point it starts over. It will keep data separated for each thread, combining information correctly from multiple threads. All StatsEventHandler names must be unique within the same TimerFactory. This StatsEventHandler is multi-thread safe.
| |
| makeStatsEventHandler | back to summary |
|---|---|
| public StatsEventHandler makeStatsEventHandler(String name) Redeclares org. Doc from org. Create a new StatsEventHandler. A StatsEventHandler records running statistics for all enter/exit pairs until it is cleared, at which point it starts over. It will keep data separated for each thread, combining information correctly from multiple threads. All StatsEventHandler names must be unique within the same TimerFactory. This StatsEventHandler must be used from a single thread.
| |
| makeTimer | back to summary |
|---|---|
| public Timer makeTimer(String name, String description) Redeclares org. Doc from org. Create a new Timer. Note that Timers cannot be destroyed, other than by garbage collecting the TimerFactory that created them.
| |
| makeTimerGroup | back to summary |
|---|---|
| public TimerGroup makeTimerGroup(String name, String description) Redeclares org. Doc from org. Create a new TimerGroup. Note that TimerGroups cannot be destroyed, other than by garbage collecting the TimerFactory that created them.
| |
| makeTracingEventHandler | back to summary |
|---|---|
| public TimerEventHandler makeTracingEventHandler(String name) Redeclares org.
| |
| numberOfIds | back to summary |
|---|---|
| public int numberOfIds() Redeclares org. Doc from org. Returns the maximum id used by this TimerFactory for creating Controllables. The value of con.id() for any Controllable created by this TimerFactory always ranges from 0 inclusive to numberOfIds() exclusive.
| |
| removeController | back to summary |
|---|---|
| public void removeController(TimerEventControllerBase controller) Redeclares org. Doc from org. Remove the controller from this factory. The controller should not be used after this call.
| |
| removeTimerEventHandler | back to summary |
|---|---|
| public void removeTimerEventHandler(TimerEventHandler handler) Redeclares org. Doc from org. Remove the handler from this TimerFactory. The handler should not be used after this call.
| |
| timerGroups | back to summary |
|---|---|
| public Map Redeclares org. Doc from org. Returns a read-only map from TimerGroup names to TimerGroups.
| |
| timers | back to summary |
|---|---|
| public Map Redeclares org. Doc from org. Returns a read-only map from Timer names to Timers.
| |
| Modifier and Type | Method and Description |
|---|---|
| public boolean | |
| public boolean |
| add | back to summary |
|---|---|
| public boolean add(Controllable con) Redeclares org.
| |
| remove | back to summary |
|---|---|
| public boolean remove(Controllable con) Redeclares org.
| |
| Access | Constructor and Description |
|---|---|
| public |
| TracingEventHandler | back to summary |
|---|---|
| public TracingEventHandler(TimerFactory factory, String name) | |