com.asakusafw.runtime.value

Class DateTime

java.lang.Object

com.asakusafw.runtime.value.DateTime

All Implemented Interfaces:

Comparable<DateTime>

public class DateTime
extends Object
implements Comparable<DateTime>

A light weight class about date and time.

See Also:

DateUtil, DateTimeOption

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DateTime.Format Represents kinds of date and time formats.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FORMAT The default date and time format.

Constructor Summary

Constructors

Constructor and Description
DateTime() Creates a new instance which represents 0001/01/01 (YYYY/MM/DD) 00:00:00.
DateTime(int year, int month, int day, int hour, int minute, int second) Creates a new instance.
DateTime(long elapsedSeconds) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
int	compareTo(DateTime o)
boolean	equals(Object obj)
int	getDay() Returns the day of this date and time.
long	getElapsedSeconds() Returns the number of elapsed seconds from 0001/01/01 (YYYY/MM/DD) 00:00:00.
int	getHour() Returns the hour of this date time.
int	getMinute() Returns the minute of this date time.
int	getMonth() Returns the month of this date and time.
int	getSecond() Returns the second of this date time.
int	getYear() Returns the year of this date and time.
int	hashCode()
void	setElapsedSeconds(long elapsed) Sets the date and time as number of elapsed seconds from 0001/01/01 (YYYY/MM/DD) 00:00:00.
String	toString()
static DateTime	valueOf(String timeString, DateTime.Format format) Parses the target string using the specified format, and returns the corresponding date and time object.
static DateTime	valueOf(StringOption timeString, DateTime.Format format) Parses the target string using the specified format, and returns the corresponding date and time as the elapsed seconds from 0001/01/01 (YYYY/MM/DD) 00:00:00.

Methods inherited from class java.lang.Object

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

Field Detail

FORMAT

public static final String FORMAT

The default date and time format.

See Also:

Constant Field Values

Constructor Detail

DateTime

public DateTime()

Creates a new instance which represents 0001/01/01 (YYYY/MM/DD) 00:00:00.

DateTime

public DateTime(long elapsedSeconds)

Creates a new instance.

Parameters:

elapsedSeconds - the number of elapsed seconds from 0001/01/01 (YYYY/MM/DD) 00:00:00 (0-origin)

DateTime

public DateTime(int year,
                int month,
                int day,
                int hour,
                int minute,
                int second)

Creates a new instance.

Parameters:

year - year (1-...)

month - month (1-12)

day - day (1-31)

hour - hour (0-23)

minute - minute (0-59)

second - second (0-59)

Method Detail

getElapsedSeconds

public long getElapsedSeconds()

Returns the number of elapsed seconds from 0001/01/01 (YYYY/MM/DD) 00:00:00.

Returns:

the number of elapsed seconds (0-origin)

setElapsedSeconds

public void setElapsedSeconds(long elapsed)

Sets the date and time as number of elapsed seconds from 0001/01/01 (YYYY/MM/DD) 00:00:00.

Parameters:

elapsed - the elapsed seconds (0-origin)

getYear

public int getYear()

Returns the year of this date and time.

Returns:

the year (1-)

getMonth

public int getMonth()

Returns the month of this date and time.

Returns:

the month (1-12)

getDay

public int getDay()

Returns the day of this date and time.

Returns:

the day (1-31)

getHour

public int getHour()

Returns the hour of this date time.

Returns:

the hour (0-23)

getMinute

public int getMinute()

Returns the minute of this date time.

Returns:

the minute (0-59)

getSecond

public int getSecond()

Returns the second of this date time.

Returns:

the second (0-59)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

compareTo

public int compareTo(DateTime o)

Specified by:

compareTo in interface Comparable<DateTime>

toString

public String toString()

Overrides:

toString in class Object

valueOf

public static DateTime valueOf(StringOption timeString,
                               DateTime.Format format)

Parses the target string using the specified format, and returns the corresponding date and time as the elapsed seconds from 0001/01/01 (YYYY/MM/DD) 00:00:00.

Parameters:

timeString - the target string

format - the format kind

Returns:

the elapsed seconds (0-origin)

Throws:

IllegalArgumentException - if the target string is malformed

valueOf

public static DateTime valueOf(String timeString,
                               DateTime.Format format)

Parses the target string using the specified format, and returns the corresponding date and time object.

Parameters:

timeString - the target string

format - the format kind

Returns:

the corresponding date and time object

Throws:

IllegalArgumentException - if the target string is malformed