net.time4j.clock

Class AdjustableClock

java.lang.Object

net.time4j.clock.AbstractClock

net.time4j.clock.AdjustableClock

All Implemented Interfaces:

TimeSource<Moment>

public final class AdjustableClock
extends AbstractClock

Allows miscellaneous adjustments to any clock.

Since:

2.1

Author:

Meno Hochschild

Concurrency:

This class is immutable as long as the underlying time source is immutable.

Method Summary

Modifier and Type	Method and Description
Moment	currentTime()
boolean	equals(Object obj)
int	hashCode()
static AdjustableClock	of(TimeSource<?> source) Creates a new adjustable clock for given time source.
static AdjustableClock	ofSystem() Yields an adjustable clock around the system clock.
String	toString() For debugging purposes.
AdjustableClock	withOffset(int offset, TimeUnit unit) Creates an adjusted clock which displays the current time with given time shift.
AdjustableClock	withPulse(TimeUnit pulse) Creates a pulsed clock which only displays the current time in given pulse unit.

Methods inherited from class net.time4j.clock.AbstractClock

inLocalView, inZonalView, inZonalView

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

ofSystem

public static AdjustableClock ofSystem()

Yields an adjustable clock around the system clock.

The clock can be adjusted using the with()-methods.

Returns:

adjustable clock wrapper

Since:

2.1

of

public static AdjustableClock of(TimeSource<?> source)

Creates a new adjustable clock for given time source.

After construction, the clock can be adjusted using the with()-methods.

Parameters:

source - time source which shall be adjusted

Returns:

new adjustable clock wrapper

Since:

2.1

withPulse

public AdjustableClock withPulse(TimeUnit pulse)

Creates a pulsed clock which only displays the current time in given pulse unit.

Parameters:

pulse - new pulse

Returns:

adjusted clock with given pulse

Since:

2.1

withOffset

public AdjustableClock withOffset(int offset,
                                  TimeUnit unit)

Creates an adjusted clock which displays the current time with given time shift.

Parameters:

offset - amount of shift

unit - unit of shift

Returns:

adjusted clock with given shift/offset

Since:

2.1

currentTime

public Moment currentTime()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

For debugging purposes.

Overrides:

toString in class Object

Returns:

description of clock state