co.codewizards.cloudstore.core.dto

Class DateTime

java.lang.Object

co.codewizards.cloudstore.core.dto.DateTime

public class DateTime
extends Object

Immutable representation of a timestamp (a date and a time).

This object serves as a DTO both inside XML and in URLs (usually as a query parameter, but it may be used inside a path, too). For this purpose, its toString() method and its single-String-argument-constructor are used.

Author:

Marco หงุ่ยตระกูล-Schulze - marco at codewizards dot co

Constructor Summary

Constructors

Constructor and Description
DateTime(Date date) Creates a new instance from the given date.
DateTime(String dateString) Creates a new instance from the given ISO-8601-encoded dateString.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
long	getMillis() Gets the number of milliseconds since 1970 January 1 00:00:00 GMT represented by this DateTime object.
int	hashCode()
Date	toDate() Converts this DateTime into a new Date instance.
String	toString() Returns an ISO-8601-encoded timestamp which can be passed to DateTime(String).

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DateTime

public DateTime(String dateString)

Creates a new instance from the given ISO-8601-encoded dateString.

The result of the toString() method can be passed to this constructor to obtain a copy of the original DateTime instance. This feature should be used to transport ISO-8601-encoded timestamps over the network:

 DateTime original = new DateTime(new Date());
 String iso8601encoded = original.toString();
 // iso8601encoded could now be transported to a remote machine as part of a
 // REST URL (e.g. as query parameter).

 // The remote machine might then decode it using this REST-conform constructor:
 DateTime copy = new DateTime(iso8601encoded);

Because of this constructor, DateTime parameters can be directly used in REST resource (a.k.a. service) methods.

Parameters:

dateString - the ISO-8601-encoded form of a timestamp. Must not be null.

See Also:

toString()

DateTime

public DateTime(Date date)

Creates a new instance from the given date.

Because Date instances are mutable, the given date is cloned. This way it can be guaranteed that DateTime instances are immutable.

Parameters:

date - the date to be cloned and wrapped in the new DateTime instance. Must not be null.

Method Detail

getMillis

public long getMillis()

Gets the number of milliseconds since 1970 January 1 00:00:00 GMT represented by this DateTime object.

Returns:

the number of milliseconds since 1970 January 1 00:00:00 GMT represented by this DateTime object.

See Also:

Date.getTime()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Returns an ISO-8601-encoded timestamp which can be passed to DateTime(String).

Inherited javadoc:

Overrides:

toString in class Object

See Also:

DateTime(String)

toDate

public Date toDate()

Converts this DateTime into a new Date instance.

Returns:

a new Date instance representing the same timestamp as this DateTime. Never null.