net.time4j

Class ZonalClock

java.lang.Object

net.time4j.ZonalClock

public final class ZonalClock
extends Object

Represents a clock which yields the current local time according to a timezone.

This class is immutable as long as the underlying implementations of time source and time zone are.

Author:

Meno Hochschild

See Also:

SystemClock.inLocalView(), SystemClock.inZonalView(TZID)

Constructor Summary

Constructors

Constructor and Description
ZonalClock(TimeSource<?> timeSource, String tzid) Constructs a new clock which can yield the current local time in given timezone.
ZonalClock(TimeSource<?> timeSource, TZID tzid) Constructs a new clock which can yield the current local time in given timezone.

Method Summary

Methods

Modifier and Type	Method and Description
TimeSource<?>	getSource() Gets the associated clock.
TZID	getTimezone() Gets the associated timezone.
PlainTimestamp	now() Gets the current timestamp in the associated timezone.
PlainDate	today() Ermittelt das aktuelle Datum in der assoziierten Zeitzone.

Methods inherited from class java.lang.Object

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

Constructor Detail

ZonalClock

public ZonalClock(TimeSource<?> timeSource,
          TZID tzid)

Constructs a new clock which can yield the current local time in given timezone.

Most users have no need to directly call this constructor. It is mainly designed for being called by dedicated expressions like SystemClock.inZonalView(tzid) etc.

Parameters:

timeSource - source for current world time (UTC)

tzid - timezone id

Throws:

IllegalArgumentException - if given timezone cannot be loaded

ZonalClock

public ZonalClock(TimeSource<?> timeSource,
          String tzid)

Constructs a new clock which can yield the current local time in given timezone.

Most users have no need to directly call this constructor. It is mainly designed for being called by dedicated expressions like SystemClock.inZonalView(tzid) etc.

Parameters:

timeSource - source for current world time (UTC)

tzid - timezone id

Throws:

IllegalArgumentException - if given timezone cannot be loaded

Method Detail

now

public PlainTimestamp now()

Gets the current timestamp in the associated timezone.

Returns:

current local timestamp

today

public PlainDate today()

Ermittelt das aktuelle Datum in der assoziierten Zeitzone.

Returns:

calendar date representing today

getSource

public TimeSource<?> getSource()

Gets the associated clock.

Returns:

time source

getTimezone

public TZID getTimezone()

Gets the associated timezone.

Returns:

timezone id