TimeString (Calcite Core 1.16.0 API)

java.lang.Object
- org.apache.calcite.util.TimeString

All Implemented Interfaces:

Comparable<TimeString>
```
public class TimeString
extends Object
implements Comparable<TimeString>
```
Time literal.
Immutable, internally represented as a string (in ISO format), and can support unlimited precision (milliseconds, nanoseconds).

Field Summary

Fields
Modifier and Type Field and Description

private static Pattern PATTERN

(package private) String v

Fields
Modifier and Type	Field and Description
`private static Pattern`	`PATTERN`
`(package private) String`	`v`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`TimeString(int h, int m, int s)` Creates a TimeString for hour, minute, second and millisecond values.
	`TimeString(String v)` Creates a TimeString.
`private`	`TimeString(String v, boolean ignore)` Internal constructor, no validation.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(TimeString o)`
`boolean`	`equals(Object o)`
`static TimeString`	`fromCalendarFields(Calendar calendar)` Creates a TimeString from a Calendar.
`static TimeString`	`fromMillisOfDay(int i)`
`private int`	`getHour()`
`private int`	`getMillisInSecond()`
`int`	`getMillisOfDay()`
`private int`	`getMinute()`
`private int`	`getSecond()`
`int`	`hashCode()`
`private static String`	`hms(int h, int m, int s)` Validates an hour-minute-second value and converts to a string.
`private int`	`precision()`
`TimeString`	`round(int precision)`
`Calendar`	`toCalendar()`
`String`	`toString()`
`String`	`toString(int precision)` Converts this TimestampString to a string, truncated or padded with zeroes to a given precision.
`TimeString`	`withFraction(String fraction)` Sets the fraction field of a `TimeString`.
`TimeString`	`withMillis(int millis)` Sets the fraction field of a `TimeString` to a given number of milliseconds.
`TimeString`	`withNanos(int nanos)` Sets the fraction field of a `TimeString` to a given number of nanoseconds.

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

- Field Detail
  - PATTERN
```
private static final Pattern PATTERN
```
  - v
```
final String v
```
- Constructor Detail
  - TimeString
```
private TimeString(String v,
                   boolean ignore)
```
    Internal constructor, no validation.
  - TimeString
```
public TimeString(String v)
```
    Creates a TimeString.
  - TimeString
```
public TimeString(int h,
                  int m,
                  int s)
```
    Creates a TimeString for hour, minute, second and millisecond values.
- Method Detail
  - hms
```
private static String hms(int h,
                          int m,
                          int s)
```
    Validates an hour-minute-second value and converts to a string.
  - withMillis
```
public TimeString withMillis(int millis)
```
    Sets the fraction field of a TimeString to a given number of milliseconds. Nukes the value set via withNanos(int).
    For example, new TimeString(1970, 1, 1, 2, 3, 4).withMillis(56) yields TIME '1970-01-01 02:03:04.056'.
  - withNanos
```
public TimeString withNanos(int nanos)
```
    Sets the fraction field of a TimeString to a given number of nanoseconds. Nukes the value set via withMillis(int).
    For example, new TimeString(1970, 1, 1, 2, 3, 4).withNanos(56789) yields TIME '1970-01-01 02:03:04.000056789'.
  - withFraction
```
public TimeString withFraction(String fraction)
```
    Sets the fraction field of a TimeString. The precision is determined by the number of leading zeros. Trailing zeros are stripped.
    For example, new TimeString(1970, 1, 1, 2, 3, 4).withFraction("00506000") yields TIME '1970-01-01 02:03:04.00506'.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - compareTo
```
public int compareTo(@Nonnull
                     TimeString o)
```
    Specified by:
    
    compareTo in interface Comparable<TimeString>
  - fromCalendarFields
```
public static TimeString fromCalendarFields(Calendar calendar)
```
    Creates a TimeString from a Calendar.
  - fromMillisOfDay
```
public static TimeString fromMillisOfDay(int i)
```
  - round
```
public TimeString round(int precision)
```
  - getMillisOfDay
```
public int getMillisOfDay()
```
  - getMillisInSecond
```
private int getMillisInSecond()
```
  - getHour
```
private int getHour()
```
  - getMinute
```
private int getMinute()
```
  - getSecond
```
private int getSecond()
```
  - toCalendar
```
public Calendar toCalendar()
```
  - toString
```
public String toString(int precision)
```
    Converts this TimestampString to a string, truncated or padded with zeroes to a given precision.
  - precision
```
private int precision()
```

Class TimeString

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PATTERN

v

Constructor Detail

TimeString

TimeString

TimeString

Method Detail

hms

withMillis

withNanos

withFraction

toString

equals

hashCode

compareTo

fromCalendarFields

fromMillisOfDay

round

getMillisOfDay

getMillisInSecond

getHour

getMinute

getSecond

toCalendar

toString

precision