Package ej.mwt.animation

Class AnimationBenchmark

java.lang.Object

ej.mwt.animation.AnimationBenchmark

public class AnimationBenchmark
extends java.lang.Object

Static utility for benchmarking animations: tracks duration and frame rate of Animation instances wrapped by track(Animation).

Enable benchmarking by setting the BON constant to true.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AnimationBenchmark.AnimationTimeoutException	Thrown by wait(String, long) when the animation did not complete within the specified timeout.
static class	AnimationBenchmark.TrackedAnimation	An Animation decorator that records timing data for benchmarking.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ENABLED_CONSTANT	Boolean BON constant that enables animation benchmarking.

Method Summary

Modifier and Type	Method	Description
static void	addNextLabel(java.lang.String label)	Queues a label to be associated with the next AnimationBenchmark.TrackedAnimation created, and sets up the synchronization lock used by wait(String, long).
static void	clear()	Resets all benchmarking state: pending labels, completion locks, and completed animations.
static Animation	track(Animation animation)	Wraps the given animation in a AnimationBenchmark.TrackedAnimation that records timing data.
static AnimationBenchmark.TrackedAnimation	wait(java.lang.String label, long timeout)	Blocks the calling thread until the AnimationBenchmark.TrackedAnimation registered under label completes, or until the timeout elapses.

Methods inherited from class java.lang.Object

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

Field Detail

ENABLED_CONSTANT

public static final java.lang.String ENABLED_CONSTANT

Boolean BON constant that enables animation benchmarking. If true and a label was queued, an animation started via Animator is automatically wrapped in a AnimationBenchmark.TrackedAnimation before execution.

Constant name: "ej.mwt.debug.animation.benchmark.enabled".

See Also:

Constant Field Values

Method Detail

track

public static Animation track(Animation animation)

Wraps the given animation in a AnimationBenchmark.TrackedAnimation that records timing data.

If a label was queued via addNextLabel(String), it is consumed (FIFO) and associated with the returned animation. Otherwise, the animation is not tracked.

Parameters:

animation - the animation to wrap; must not be null

Returns:

a AnimationBenchmark.TrackedAnimation delegating to animation

wait

public static AnimationBenchmark.TrackedAnimation wait(java.lang.String label,
                                                       long timeout)
                                                throws AnimationBenchmark.AnimationTimeoutException,
                                                       java.lang.InterruptedException

Blocks the calling thread until the AnimationBenchmark.TrackedAnimation registered under label completes, or until the timeout elapses.

addNextLabel(String) must be called with the same label before the animation is started, otherwise an IllegalStateException is thrown.

Parameters:

label - the label of the animation to wait for

timeout - the maximum time to wait, in milliseconds

Throws:

java.lang.IllegalStateException - if called from the UI thread or no animation was registered with the given label via addNextLabel(String)

AnimationBenchmark.AnimationTimeoutException - if the animation did not complete within the timeout

java.lang.InterruptedException - if the calling thread is interrupted while waiting

addNextLabel

public static void addNextLabel(java.lang.String label)

Queues a label to be associated with the next AnimationBenchmark.TrackedAnimation created, and sets up the synchronization lock used by wait(String, long).

Must be called before the animation is started. Labels are consumed in FIFO order.

Parameters:

label - the label to associate with the next benchmarked animation

clear

public static void clear()

Resets all benchmarking state: pending labels, completion locks, and completed animations.

Call this between test runs to ensure a clean state.