Module jakarta.data

Package jakarta.data.spi.expression.literal

Interface TemporalLiteral<V extends Temporal & Comparable<? extends Temporal>>

Type Parameters:

V - entity attribute type.

All Superinterfaces:

ComparableExpression<Object,V>, ComparableLiteral<V>, Expression<Object,V>, Literal<V>, TemporalExpression<Object,V>

public interface TemporalLiteral<V extends Temporal & Comparable<? extends Temporal>>
extends ComparableLiteral<V>, TemporalExpression<Object,V>

A literal for a temporal value.

Since:

1.1

Method Summary

Modifier and Type	Method	Description
static <V extends Temporal & Comparable<? extends Temporal>> TemporalLiteral<V>	of(Class<V> type, V value)	Creates a TemporalLiteral that represents the given value.
static TemporalLiteral<Instant>	of(Instant value)	Create a TemporalLiteral representing the given Instant.
static TemporalLiteral<LocalDate>	of(LocalDate value)	Create a TemporalLiteral representing the given LocalDate.
static TemporalLiteral<LocalDateTime>	of(LocalDateTime value)	Create a TemporalLiteral representing the given LocalDateTime.
static TemporalLiteral<LocalTime>	of(LocalTime value)	Create a TemporalLiteral representing the given LocalTime.
static TemporalLiteral<Year>	of(Year value)	Create a TemporalLiteral representing the given Year.
String	toString()	Returns a String representing the literal temporal value.

Methods inherited from interface jakarta.data.expression.ComparableExpression

between, between, greaterThan, greaterThan, greaterThanEqual, greaterThanEqual, lessThan, lessThan, lessThanEqual, lessThanEqual, notBetween, notBetween

Methods inherited from interface jakarta.data.expression.Expression

equalTo, equalTo, in, in, in, isNull, notEqualTo, notEqualTo, notIn, notIn, notIn, notNull, satisfies, type

Methods inherited from interface jakarta.data.spi.expression.literal.Literal

value

Method Details

of

static <V extends Temporal & Comparable<? extends Temporal>>
TemporalLiteral<V> of(Class<V> type,
 V value)

Creates a TemporalLiteral that represents the given value.

Type Parameters:

V - entity attribute type.

Parameters:

value - an immutable temporal value. Must never be null.

Returns:

a TemporalLiteral representing the value.

Throws:

NullPointerException - if the value is null.

of

static TemporalLiteral<Instant> of(Instant value)

Create a TemporalLiteral representing the given Instant.

of

static TemporalLiteral<LocalDateTime> of(LocalDateTime value)

Create a TemporalLiteral representing the given LocalDateTime.

of

static TemporalLiteral<LocalDate> of(LocalDate value)

Create a TemporalLiteral representing the given LocalDate.

of

static TemporalLiteral<LocalTime> of(LocalTime value)

Create a TemporalLiteral representing the given LocalTime.

of

static TemporalLiteral<Year> of(Year value)

Create a TemporalLiteral representing the given Year.

toString

String toString()

Returns a String representing the literal temporal value. The String begins with an opening curly brace and ends with a closing curly brace. Between the braces are 2 or 3 terms delimited by a space character. The first term is

• ts for Instant and LocalDateTime,
• d for LocalDate and Year,
• t for LocalTime, or
• TemporalLiteral for all other types, in which case a middle term is included. The middle term is the fully qualified class name of the value's type.

For Instant, the final term is the LocalDate and LocalTime components of the Instant in UTC, delimited by a space character and enclosed in single quotes.

For LocalDateTime, the final term is the LocalDate and LocalTime components delimited by a space character and enclosed in single quotes.

For all other types, the final term is the toString() output of the value enclosed in single quotes.

For example, the output of TemporalLiteral.of(LocalDate.of(2025, 5, 8)).toString() is

 {d '2025-05-08'}
 

The output of TemporalLiteral.of(LocalDateTime.of(2025, 5, 9, 16, 25, 52)).toString() is

 {ts '2025-05-09 16:25:52'}
 

Specified by:

toString in interface ComparableLiteral<V extends Temporal & Comparable<? extends Temporal>>

Specified by:

toString in interface Literal<V extends Temporal & Comparable<? extends Temporal>>

Overrides:

toString in class Object

Returns:

a String representing the literal temporal value.