OTime (OJAI Core Library for Java v. 3.0)

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

All Implemented Interfaces:

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

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`OTime(Date date)` Constructs an `OTime` instance from a `java.util.Date` using exactly the same field values.
`OTime(int hourOfDay, int minutes, int seconds)` Constructs an `OTime` instance set to the specified hour, minute and seconds.
`OTime(int hourOfDay, int minutes, int seconds, int ms)` Constructs an `OTime` instance set to the specified hour, minute, seconds and milliseconds.
`OTime(long epoh)` Constructs an `OTime` 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(OTime o)`
`boolean`	`equals(Object obj)`
`static OTime`	`fromMillisOfDay(int millisOfDay)` Return an `OTime` instance from the specified milliseconds since midnight.
`int`	`getHour()`
`int`	`getMilliSecond()`
`int`	`getMinute()`
`int`	`getSecond()`
`int`	`hashCode()`
`static OTime`	`parse(String timeStr)` Parses and return an instance of `OTime` from the specified string.
`Date`	`toDate()` Get this TIME as a `Date` in the default timezone.
`String`	`toFullTimeStr()` Returns a string representation of this TIME in "HH:mm.ss.SSS" format.
`String`	`toShortTimeStr()`
`String`	`toString()`
`String`	`toString(String pattern)` Returns a string representation of this TIME using the specified format pattern.
`int`	`toTimeInMillis()`
`String`	`toTimeStr()` Returns a string representation of this TIME in "HH:mm.ss[.SSS]" format.

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

- Constructor Detail
  - OTime
```
public OTime(long epoh)
```
    Constructs an OTime instance from the milliseconds value since the Unix epoch. The TIME value is set to the corresponding time in the default time zone.
    
    Parameters:
    
    epoh - the milliseconds from 1970-01-01T00:00:00.000 UTC
  - OTime
```
public OTime(int hourOfDay,
             int minutes,
             int seconds)
```
    Constructs an OTime instance set to the specified hour, minute and seconds.
    
    Parameters:
    
    hourOfDay - the hour of the day, from 0 to 23
    
    minutes - the minute of the hour, from 0 to 59
    
    seconds - the second of the minute, from 0 to 59
  - OTime
```
public OTime(int hourOfDay,
             int minutes,
             int seconds,
             int ms)
```
    Constructs an OTime instance set to the specified hour, minute, seconds and milliseconds.
    
    Parameters:
    
    hourOfDay - the hour of the day, from 0 to 23
    
    minutes - the minute of the hour, from 0 to 59
    
    seconds - the second of the minute, from 0 to 59
    
    ms - the millisecond of the second, from 0 to 999
  - OTime
```
public OTime(Date date)
```
    Constructs an OTime instance from a java.util.Date using exactly the same field values. The TIME value is set to the corresponding time in the default time zone.
    
    Parameters:
    
    date - the Date to extract fields from
- Method Detail
  - parse
```
public static OTime parse(String timeStr)
```
    Parses and return an instance of OTime from the specified string.
    
    Parameters:
    
    timeStr - the string to parse
    
    Throws:
    
    ParseException - if the beginning of the specified string cannot be parsed.
  - fromMillisOfDay
```
public static OTime fromMillisOfDay(int millisOfDay)
```
    Return an OTime instance from the specified milliseconds since midnight.
    
    Parameters:
    
    millisOfDay - the number of milliseconds since midnight
  - getHour
```
public int getHour()
```
    Returns:
    
    The hour part of this OTime as an int.
  - getMinute
```
public int getMinute()
```
    Returns:
    
    The minute part of this OTime as an int.
  - getSecond
```
public int getSecond()
```
    Returns:
    
    The second part of this OTime as an int.
  - getMilliSecond
```
public int getMilliSecond()
```
    Returns:
    
    The millisecond part of this OTime as an int.
  - toDate
```
public Date toDate()
```
    Get this TIME as a Date in the default timezone. The year, month and date fields of the Date object is set to Unix epoch date (1970-01-01).
    
    Returns:
    
    a Date initialized with this TIME
  - toTimeInMillis
```
public int toTimeInMillis()
```
    Returns:
    
    The total number milliseconds since the midnight for this TIME in UTC.
  - toShortTimeStr
```
public String toShortTimeStr()
```
    Returns:
    
    A string representation of this TIME in "HH:mm" format
  - toFullTimeStr
```
public String toFullTimeStr()
```
    Returns a string representation of this TIME in "HH:mm.ss.SSS" format.
  - toTimeStr
```
public String toTimeStr()
```
    Returns a string representation of this TIME in "HH:mm.ss[.SSS]" format. The milliseconds are omitted if zero.
  - toString
```
public String toString(String pattern)
```
    Returns a string representation of this TIME 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(OTime o)
```
    Specified by:
    
    compareTo in interface Comparable<OTime>

Class OTime

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OTime

OTime

OTime

OTime

Method Detail

parse

fromMillisOfDay

getHour

getMinute

getSecond

getMilliSecond

toDate

toTimeInMillis

toShortTimeStr

toFullTimeStr

toTimeStr

toString

toString

hashCode

equals

compareTo