chargerlib

Class CDateTime

Object

chargerlib.CDateTime

All Implemented Interfaces:

Serializable

public class CDateTime
extends Object
implements Serializable

/** Encapsulates the representation of date/time values. As a wrapper for ZonedDateTime, an internal time value is represented by a ZonedDateTime. The style of its format depends on its use at different places in the MMAT.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CDateTime.STYLE Indicates differing string formats used in the MMAT.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) ZonedDateTime	dateTime

Constructor Summary

Constructors

Constructor and Description
CDateTime() Creates a new instance corresponding to the current date/time ("now") in the system default time zone as defined in its Locale.
CDateTime(String timeString) Create a new instance corresponding to the date/time represented by the string.

Method Summary

Modifier and Type	Method and Description
boolean	after(CDateTime other) Compare this date/time value with another.
boolean	before(CDateTime other) Compare this date/time value with another.
boolean	equals(CDateTime other) Compare this date/time value with another.
String	formatted(CDateTime.STYLE style) Use one of the pre-defined styles to format the date string.
String	formatted(String pattern) Use any format pattern to display the string.
static CDateTime	getEpoch() Get the date time object that corresponds to the beginning of the epoch.
long	getTime() Fills the same role as the old Date.time() method, returning the number of milliseconds since the epoch.
ZonedDateTime	getZonedDateTimeValue() Get this date/time value in zoned date time form.
boolean	inFuture() Determines whether the given date/time is in the future when the method is called.
boolean	inPast() Determines whether the given date/time is in the past when the method is called.
void	setZonedDateTimeValue(ZonedDateTime dateTime) Set the date/time value from a zoned date time value.
String	toString() Convenience method for using the ZONED_TIMESTAMP style.

Methods inherited from class Object

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

Field Detail

dateTime

ZonedDateTime dateTime

Constructor Detail

CDateTime

public CDateTime()

Creates a new instance corresponding to the current date/time ("now") in the system default time zone as defined in its Locale.

CDateTime

public CDateTime(String timeString)
          throws DateTimeException

Create a new instance corresponding to the date/time represented by the string. Applies each of the available style format parsers until it finds one that works.

Parameters:

timeString - A date/time string recognized by one of the defined style's formatters. If it is not recognized by any of them, an exception is thrown.

Throws:

DateTimeException

Method Detail

formatted

public String formatted(CDateTime.STYLE style)

Use one of the pre-defined styles to format the date string.

Parameters:

style -

Returns:

the date in string from as specified by the style.

formatted

public String formatted(String pattern)

Use any format pattern to display the string.

Parameters:

pattern -

Returns:

See Also:

DateTimeFormatter

getZonedDateTimeValue

public ZonedDateTime getZonedDateTimeValue()

Get this date/time value in zoned date time form.

Returns:

the date/time value of this object.

setZonedDateTimeValue

public void setZonedDateTimeValue(ZonedDateTime dateTime)

Set the date/time value from a zoned date time value.

Parameters:

dateTime - non-null date time value.

toString

public String toString()

Convenience method for using the ZONED_TIMESTAMP style.

Overrides:

toString in class Object

Returns:

after

public boolean after(CDateTime other)

Compare this date/time value with another.

Parameters:

other - another date/time value

Returns:

true if the other value is an instant after this one; false otherwise.

before

public boolean before(CDateTime other)

Compare this date/time value with another.

Parameters:

other - another date/time value

Returns:

true if the other value is an instant before this one; false otherwise.

equals

public boolean equals(CDateTime other)

Compare this date/time value with another.

Parameters:

other - another date/time value

Returns:

true if the other value is equal to this one, accounting for time zone.

See Also:

ZonedDateTime.equals(java.lang.Object)

getEpoch

public static CDateTime getEpoch()

Get the date time object that corresponds to the beginning of the epoch. Note that it will reflect the time zone, so the date may actually be Dec 31, 1969.

Returns:

getTime

public long getTime()

Fills the same role as the old Date.time() method, returning the number of milliseconds since the epoch.

Returns:

inFuture

public boolean inFuture()

Determines whether the given date/time is in the future when the method is called.

Returns:

true if it's in the future; false otherwise.

inPast

public boolean inPast()

Determines whether the given date/time is in the past when the method is called.

Returns:

true if it's in the future; false otherwise.