TimestampString (Calcite Core 1.16.0 API)

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

All Implemented Interfaces:

Comparable<TimestampString>
```
public class TimestampString
extends Object
implements Comparable<TimestampString>
```
Timestamp 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
Constructor and Description
`TimestampString(int year, int month, int day, int h, int m, int s)` Creates a TimestampString for year, month, day, hour, minute, second, millisecond values.
`TimestampString(String v)` Creates a TimeString.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(TimestampString o)`
`boolean`	`equals(Object o)`
`static TimestampString`	`fromCalendarFields(Calendar calendar)` Creates a TimestampString from a Calendar.
`static TimestampString`	`fromMillisSinceEpoch(long millis)` Creates a TimestampString that is a given number of milliseconds since the epoch.
`private int`	`getMillisInSecond()`
`long`	`getMillisSinceEpoch()` Returns the number of milliseconds since the epoch.
`int`	`hashCode()`
`private int`	`precision()`
`TimestampString`	`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.
`TimestampString`	`withFraction(String fraction)` Sets the fraction field of a `TimestampString`.
`TimestampString`	`withMillis(int millis)` Sets the fraction field of a `TimestampString` to a given number of milliseconds.
`TimestampString`	`withNanos(int nanos)` Sets the fraction field of a `TimestampString` 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
  - TimestampString
```
public TimestampString(String v)
```
    Creates a TimeString.
  - TimestampString
```
public TimestampString(int year,
                       int month,
                       int day,
                       int h,
                       int m,
                       int s)
```
    Creates a TimestampString for year, month, day, hour, minute, second, millisecond values.
- Method Detail
  - withMillis
```
public TimestampString withMillis(int millis)
```
    Sets the fraction field of a TimestampString to a given number of milliseconds. Nukes the value set via withNanos(int).
    For example, new TimestampString(1970, 1, 1, 2, 3, 4).withMillis(56) yields TIMESTAMP '1970-01-01 02:03:04.056'.
  - withNanos
```
public TimestampString withNanos(int nanos)
```
    Sets the fraction field of a TimestampString to a given number of nanoseconds. Nukes the value set via withMillis(int).
    For example, new TimestampString(1970, 1, 1, 2, 3, 4).withNanos(56789) yields TIMESTAMP '1970-01-01 02:03:04.000056789'.
  - withFraction
```
public TimestampString withFraction(String fraction)
```
    Sets the fraction field of a TimestampString. The precision is determined by the number of leading zeros. Trailing zeros are stripped.
    For example, new TimestampString(1970, 1, 1, 2, 3, 4).withFraction("00506000") yields TIMESTAMP '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(TimestampString o)
```
    Specified by:
    
    compareTo in interface Comparable<TimestampString>
  - fromCalendarFields
```
public static TimestampString fromCalendarFields(Calendar calendar)
```
    Creates a TimestampString from a Calendar.
  - round
```
public TimestampString round(int precision)
```
  - getMillisSinceEpoch
```
public long getMillisSinceEpoch()
```
    Returns the number of milliseconds since the epoch.
  - getMillisInSecond
```
private int getMillisInSecond()
```
  - fromMillisSinceEpoch
```
public static TimestampString fromMillisSinceEpoch(long millis)
```
    Creates a TimestampString that is a given number of milliseconds since the epoch.
  - 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 TimestampString

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PATTERN

v

Constructor Detail

TimestampString

TimestampString

Method Detail

withMillis

withNanos

withFraction

toString

equals

hashCode

compareTo

fromCalendarFields

round

getMillisSinceEpoch

getMillisInSecond

fromMillisSinceEpoch

toCalendar

toString

precision