Top Description Inners Fields Constructors Methods
org.apache.logging.log4j.util

public Class Timer

extends Object
implements Serializable, StringBuilderFormattable
Class Inheritance
All Implemented Interfaces
org.apache.logging.log4j.util.StringBuilderFormattable, java.io.Serializable
Imports
java.io.Serializable, java.text.DecimalFormat
Primarily used in unit tests, but can be used to track elapsed time for a request or portion of any other operation so long as all the timer methods are called on the same thread in which it was started. Calling start on multiple threads will cause the times to be aggregated.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
Timer.Status

Field Summary

Modifier and TypeField and Description
private long
elapsedTime

private final int
iterations

private final String
name

private static long
NANO_PER_HOUR

private static long
NANO_PER_MINUTE

private static long
NANO_PER_SECOND

private static final long
serialVersionUID

private ThreadLocal<Long>
startTime

private Timer.Status
status

Constructor Summary

AccessConstructor and Description
public
Timer(final String
the timer name.
name)

Constructor.

public
Timer(final String
the timer name.
name, final int iterations)

Constructor.

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(final Object
the reference object with which to compare.
o)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public void
formatTo(final StringBuilder
the StringBuilder to write into
buffer)

Implements org.apache.logging.log4j.util.StringBuilderFormattable.formatTo.

Writes a text representation of this object into the specified StringBuilder, ideally without allocating temporary objects.

public long

Returns:

the elapsed time.
getElapsedNanoTime()

Access the elapsed time.

public long

Returns:

the elapsed time.
getElapsedTime()

Access the elapsed time.

public String

Returns:

the timer's name.
getName()

Accessor for the name.

public Timer.Status

Returns:

the string representing the last operation performed.
getStatus()

Returns the name of the last operation performed on this timer (Start, Stop, Pause or Resume).

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public synchronized void
pause()

Pause the timer.

public synchronized void
resume()

Resume the timer.

public synchronized void
start()

Start the timer.

public synchronized void
startOrResume()

public synchronized String
stop()

Stop the timer.

public String
toString()

Overrides java.lang.Object.toString.

Returns the String representation of the timer based upon its current state

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

elapsedTimeback to summary
private long elapsedTime
iterationsback to summary
private final int iterations
nameback to summary
private final String name
NANO_PER_HOURback to summary
private static long NANO_PER_HOUR
NANO_PER_MINUTEback to summary
private static long NANO_PER_MINUTE
NANO_PER_SECONDback to summary
private static long NANO_PER_SECOND
serialVersionUIDback to summary
private static final long serialVersionUID
startTimeback to summary
private ThreadLocal<Long> startTime
statusback to summary
private Timer.Status status

Constructor Detail

Timerback to summary
public Timer(final String name)

Constructor.

Parameters
name:String

the timer name.

Timerback to summary
public Timer(final String name, final int iterations)

Constructor.

Parameters
name:String

the timer name.

Method Detail

equalsback to summary
public boolean equals(final Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
formatToback to summary
public void formatTo(final StringBuilder buffer)

Implements org.apache.logging.log4j.util.StringBuilderFormattable.formatTo.

Doc from org.apache.logging.log4j.util.StringBuilderFormattable.formatTo.

Writes a text representation of this object into the specified StringBuilder, ideally without allocating temporary objects.

Parameters
buffer:StringBuilder

the StringBuilder to write into

Annotations
@Override
getElapsedNanoTimeback to summary
public long getElapsedNanoTime()

Access the elapsed time.

Returns:long

the elapsed time.

getElapsedTimeback to summary
public long getElapsedTime()

Access the elapsed time.

Returns:long

the elapsed time.

getNameback to summary
public String getName()

Accessor for the name.

Returns:String

the timer's name.

getStatusback to summary
public Timer.Status getStatus()

Returns the name of the last operation performed on this timer (Start, Stop, Pause or Resume).

Returns:Timer.Status

the string representing the last operation performed.

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
pauseback to summary
public synchronized void pause()

Pause the timer.

resumeback to summary
public synchronized void resume()

Resume the timer.

startback to summary
public synchronized void start()

Start the timer.

startOrResumeback to summary
public synchronized void startOrResume()
stopback to summary
public synchronized String stop()

Stop the timer.

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Returns the String representation of the timer based upon its current state

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object

Annotations
@Override
org.apache.logging.log4j.util back to summary

public final Enum Timer.Status

extends Enum<Timer.Status>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final Timer.Status
Paused

public static final Timer.Status
Started

public static final Timer.Status
Stopped

Constructor Summary

AccessConstructor and Description
private
Status()

Method Summary

Modifier and TypeMethod and Description
public static Timer.Status
valueOf(String name)

public static Timer.Status[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

Pausedback to summary
public static final Timer.Status Paused
Startedback to summary
public static final Timer.Status Started
Stoppedback to summary
public static final Timer.Status Stopped

Constructor Detail

Statusback to summary
private Status()

Method Detail

valueOfback to summary
public static Timer.Status valueOf(String name)
valuesback to summary
public static Timer.Status[] values()