OTimestamp (OJAI Core Library for Java v. 3.0)

java.lang.Object
- org.ojai.types.OTimestamp

All Implemented Interfaces:

Serializable, Comparable<OTimestamp>
```
@API.Public
public final class OTimestamp
extends Object
implements Comparable<OTimestamp>, Serializable
```
An immutable class which encapsulates an OJAI TIMESTAMP type.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`OTimestamp(Date date)` Constructs an `OTimestamp` instance from a `java.util.Date` using exactly the same field values.
`OTimestamp(int year, int monthOfYear, int dayOfMonth, int hourOfDay, int minuteOfHour, int secondOfMinute, int millisOfSecond)` Constructs an `OTimestamp` instance set to the specified fields in the default time zone.
`OTimestamp(long millisSinceEpoch)` Constructs an `OTimestamp` instance from the milliseconds value since the Unix epoch.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(OTimestamp o)`
`boolean`	`equals(Object obj)`
`int`	`getDayOfMonth()`
`int`	`getHour()`
`long`	`getMillis()`
`int`	`getMilliSecond()`
`int`	`getMinute()`
`int`	`getMonth()`
`int`	`getSecond()`
`int`	`getYear()`
`int`	`hashCode()`
`static OTimestamp`	`parse(String dateTimeStr)` Parses and return an instance of `OTimestamp` from the specified string.
`Date`	`toDate()` Get this timestamp as a `Date`.
`String`	`toLocalString()` Returns the ISO8601 format timestamp string in local time zone.
`String`	`toString()`
`String`	`toString(String pattern)` Return the string representation the timestamp using the specified format pattern.
`String`	`toUTCString()` Returns the ISO8601 format timestamp string in UTC.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - OTimestamp
```
public OTimestamp(long millisSinceEpoch)
```
    Constructs an OTimestamp instance from the milliseconds value since the Unix epoch.
    
    Parameters:
    
    millisSinceEpoch - the milliseconds from 1970-01-01T00:00:00.000 UTC
  - OTimestamp
```
public OTimestamp(int year,
                  int monthOfYear,
                  int dayOfMonth,
                  int hourOfDay,
                  int minuteOfHour,
                  int secondOfMinute,
                  int millisOfSecond)
```
    Constructs an OTimestamp instance set to the specified fields in the default time zone.
    
    Parameters:
    
    year - the year
    
    monthOfYear - the month of the year, from 1 to 12
    
    dayOfMonth - the day of the month, from 1 to 31
    
    hourOfDay - the hour of the day, from 0 to 23
    
    minuteOfHour - the minute of the hour, from 0 to 59
    
    secondOfMinute - the second of the minute, from 0 to 59
    
    millisOfSecond - the millisecond of the second, from 0 to 999
  - OTimestamp
```
public OTimestamp(Date date)
```
    Constructs an OTimestamp instance from a java.util.Date using exactly the same field values.
    
    Parameters:
    
    date - the Date to extract fields from
- Method Detail
  - parse
```
public static OTimestamp parse(String dateTimeStr)
```
    Parses and return an instance of OTimestamp from the specified string.
    
    Parameters:
    
    dateTimeStr - the string to parse
    
    Throws:
    
    ParseException - if the beginning of the specified string cannot be parsed.
  - getYear
```
public int getYear()
```
    Returns:
    
    The UTC years value of this Timestamp as an int.
  - getMonth
```
public int getMonth()
```
    Returns:
    
    The UTC months value of this Timestamp as an int.
  - getDayOfMonth
```
public int getDayOfMonth()
```
    Returns:
    
    The UTC date of month value of this Timestamp as an int.
  - getHour
```
public int getHour()
```
    Returns:
    
    The UTC hour part of this Timestamp as an int.
  - getMinute
```
public int getMinute()
```
    Returns:
    
    The UTC minute part of this Timestamp as an int.
  - getSecond
```
public int getSecond()
```
    Returns:
    
    The UTC second part of this Timestamp as an int.
  - getMilliSecond
```
public int getMilliSecond()
```
    Returns:
    
    The UTC millisecond part of this Timestamp as an int.
  - getMillis
```
public long getMillis()
```
    Returns:
    
    The total number milliseconds since the Unix epoch.
  - toDate
```
public Date toDate()
```
    Get this timestamp as a Date. The Date object created has exactly the same millisecond as this timestamp.
    
    Returns:
    
    a Date initialized with this TIMESTAMP
  - toUTCString
```
public String toUTCString()
```
    Returns the ISO8601 format timestamp string in UTC.
  - toLocalString
```
public String toLocalString()
```
    Returns the ISO8601 format timestamp string in local time zone.
  - toString
```
public String toString(String pattern)
```
    Return the string representation the timestamp using the specified format pattern.
    
    Parameters:
    
    pattern - the pattern specification
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - compareTo
```
public int compareTo(OTimestamp o)
```
    Specified by:
    
    compareTo in interface Comparable<OTimestamp>

Class OTimestamp

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OTimestamp

OTimestamp

OTimestamp

Method Detail

parse

getYear

getMonth

getDayOfMonth

getHour

getMinute

getSecond

getMilliSecond

getMillis

toDate

toUTCString

toLocalString

toString

toString

hashCode

equals

compareTo