com.netflix.servo.util

Enum ClockWithOffset

java.lang.Object

java.lang.Enum<ClockWithOffset>

com.netflix.servo.util.ClockWithOffset

All Implemented Interfaces:

Clock, java.io.Serializable, java.lang.Comparable<ClockWithOffset>

public enum ClockWithOffset
extends java.lang.Enum<ClockWithOffset>
implements Clock

A Clock that provides a way to modify the time returned by System.currentTimeMillis().

This can be used during application shutdown to force the clock forward and get the latest values which normally would not be returned until the next step boundary is crossed.

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE Singleton.

Field Summary

Fields inherited from interface com.netflix.servo.util.Clock

WALL

Method Summary

Modifier and Type	Method and Description
long	now() Returns the number of milliseconds since the epoch.
void	setOffset(long offset) Sets the offset for the clock.
static ClockWithOffset	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ClockWithOffset[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final ClockWithOffset INSTANCE

Singleton.

Method Detail

values

public static ClockWithOffset[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ClockWithOffset c : ClockWithOffset.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ClockWithOffset valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

setOffset

public void setOffset(long offset)

Sets the offset for the clock.

Parameters:

offset - Number of milliseconds to add to the current time.

now

public long now()

Returns the number of milliseconds since the epoch.

Specified by:

now in interface Clock