Literals (client-java 0.8.0-incubating API)

java.lang.Object
- org.apache.gravitino.rel.expressions.literals.Literals

```
public class Literals
extends java.lang.Object
```
The helper class to create literals to pass into Apache Gravitino.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Literals.LiteralImpl<T>
Creates a literal with the given type value.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Literals.LiteralImpl<T>` Creates a literal with the given type value.

Field Summary

Fields
Modifier and Type Field and Description

static Literal<Types.NullType> NULL
Used to represent a null literal.

Fields
Modifier and Type	Field and Description
`static Literal<Types.NullType>`	`NULL` Used to represent a null literal.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Literals.LiteralImpl<java.lang.Boolean>`	`booleanLiteral(java.lang.Boolean value)` Creates a boolean type literal with the given value.
`static Literals.LiteralImpl<java.lang.Byte>`	`byteLiteral(java.lang.Byte value)` Creates a byte type literal with the given value.
`static Literals.LiteralImpl<java.time.LocalDate>`	`dateLiteral(java.time.LocalDate value)` Creates a date type literal with the given value.
`static Literals.LiteralImpl<Decimal>`	`decimalLiteral(Decimal value)` Creates a decimal type literal with the given value.
`static Literals.LiteralImpl<java.lang.Double>`	`doubleLiteral(java.lang.Double value)` Creates a double type literal with the given value.
`static Literals.LiteralImpl<java.lang.Float>`	`floatLiteral(java.lang.Float value)` Creates a float type literal with the given value.
`static Literals.LiteralImpl<java.lang.Integer>`	`integerLiteral(java.lang.Integer value)` Creates an integer type literal with the given value.
`static Literals.LiteralImpl<java.lang.Long>`	`longLiteral(java.lang.Long value)` Creates a long type literal with the given value.
`static <T> Literals.LiteralImpl<T>`	`of(T value, Type dataType)` Creates a literal with the given value and data type.
`static Literals.LiteralImpl<java.lang.Short>`	`shortLiteral(java.lang.Short value)` Creates a short type literal with the given value.
`static Literals.LiteralImpl<java.lang.String>`	`stringLiteral(java.lang.String value)` Creates a string type literal with the given value.
`static Literals.LiteralImpl<java.time.LocalTime>`	`timeLiteral(java.time.LocalTime value)` Creates a time type literal with the given value.
`static Literals.LiteralImpl<java.time.LocalDateTime>`	`timestampLiteral(java.time.LocalDateTime value)` Creates a timestamp type literal with the given value.
`static Literals.LiteralImpl<java.time.LocalDateTime>`	`timestampLiteral(java.lang.String value)` Creates a timestamp type literal with the given value.
`static Literals.LiteralImpl<java.lang.Short>`	`unsignedByteLiteral(java.lang.Short value)` Creates an unsigned byte type literal with the given value.
`static Literals.LiteralImpl<java.lang.Long>`	`unsignedIntegerLiteral(java.lang.Long value)` Creates an unsigned integer type literal with the given value.
`static Literals.LiteralImpl<Decimal>`	`unsignedLongLiteral(Decimal value)` Creates an unsigned long type literal with the given value.
`static Literals.LiteralImpl<java.lang.Integer>`	`unsignedShortLiteral(java.lang.Integer value)` Creates an unsigned short type literal with the given value.
`static Literals.LiteralImpl<java.lang.String>`	`varcharLiteral(int length, java.lang.String value)` Creates a varchar type literal with the given value.

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

- Field Detail
  - NULL
```
public static final Literal<Types.NullType> NULL
```
    Used to represent a null literal.
- Method Detail
  - of
```
public static <T> Literals.LiteralImpl<T> of(T value,
                                             Type dataType)
```
    Creates a literal with the given value and data type.
    
    Type Parameters:
    
    T - the JVM type of value held by the literal
    
    Parameters:
    
    value - the literal value
    
    dataType - the data type of the literal
    
    Returns:
    
    a new Literal instance
  - booleanLiteral
```
public static Literals.LiteralImpl<java.lang.Boolean> booleanLiteral(java.lang.Boolean value)
```
    Creates a boolean type literal with the given value.
    
    Parameters:
    
    value - the boolean literal value
    
    Returns:
    
    a new Literal instance
  - byteLiteral
```
public static Literals.LiteralImpl<java.lang.Byte> byteLiteral(java.lang.Byte value)
```
    Creates a byte type literal with the given value.
    
    Parameters:
    
    value - the byte literal value
    
    Returns:
    
    a new Literal instance
  - unsignedByteLiteral
```
public static Literals.LiteralImpl<java.lang.Short> unsignedByteLiteral(java.lang.Short value)
```
    Creates an unsigned byte type literal with the given value.
    
    Parameters:
    
    value - the unsigned byte literal value
    
    Returns:
    
    a new Literal instance
  - shortLiteral
```
public static Literals.LiteralImpl<java.lang.Short> shortLiteral(java.lang.Short value)
```
    Creates a short type literal with the given value.
    
    Parameters:
    
    value - the short literal value
    
    Returns:
    
    a new Literal instance
  - unsignedShortLiteral
```
public static Literals.LiteralImpl<java.lang.Integer> unsignedShortLiteral(java.lang.Integer value)
```
    Creates an unsigned short type literal with the given value.
    
    Parameters:
    
    value - the unsigned short literal value
    
    Returns:
    
    a new Literal instance
  - integerLiteral
```
public static Literals.LiteralImpl<java.lang.Integer> integerLiteral(java.lang.Integer value)
```
    Creates an integer type literal with the given value.
    
    Parameters:
    
    value - the integer literal value
    
    Returns:
    
    a new Literal instance
  - unsignedIntegerLiteral
```
public static Literals.LiteralImpl<java.lang.Long> unsignedIntegerLiteral(java.lang.Long value)
```
    Creates an unsigned integer type literal with the given value.
    
    Parameters:
    
    value - the unsigned integer literal value
    
    Returns:
    
    a new Literal instance
  - longLiteral
```
public static Literals.LiteralImpl<java.lang.Long> longLiteral(java.lang.Long value)
```
    Creates a long type literal with the given value.
    
    Parameters:
    
    value - the long literal value
    
    Returns:
    
    a new Literal instance
  - unsignedLongLiteral
```
public static Literals.LiteralImpl<Decimal> unsignedLongLiteral(Decimal value)
```
    Creates an unsigned long type literal with the given value.
    
    Parameters:
    
    value - the unsigned long literal value
    
    Returns:
    
    a new Literal instance
  - floatLiteral
```
public static Literals.LiteralImpl<java.lang.Float> floatLiteral(java.lang.Float value)
```
    Creates a float type literal with the given value.
    
    Parameters:
    
    value - the float literal value
    
    Returns:
    
    a new Literal instance
  - doubleLiteral
```
public static Literals.LiteralImpl<java.lang.Double> doubleLiteral(java.lang.Double value)
```
    Creates a double type literal with the given value.
    
    Parameters:
    
    value - the double literal value
    
    Returns:
    
    a new Literal instance
  - decimalLiteral
```
public static Literals.LiteralImpl<Decimal> decimalLiteral(Decimal value)
```
    Creates a decimal type literal with the given value.
    
    Parameters:
    
    value - the decimal literal value
    
    Returns:
    
    a new Literal instance
  - dateLiteral
```
public static Literals.LiteralImpl<java.time.LocalDate> dateLiteral(java.time.LocalDate value)
```
    Creates a date type literal with the given value.
    
    Parameters:
    
    value - the date literal value
    
    Returns:
    
    a new Literal instance
  - timeLiteral
```
public static Literals.LiteralImpl<java.time.LocalTime> timeLiteral(java.time.LocalTime value)
```
    Creates a time type literal with the given value.
    
    Parameters:
    
    value - the time literal value
    
    Returns:
    
    a new Literal instance
  - timestampLiteral
```
public static Literals.LiteralImpl<java.time.LocalDateTime> timestampLiteral(java.time.LocalDateTime value)
```
    Creates a timestamp type literal with the given value.
    
    Parameters:
    
    value - the timestamp literal value
    
    Returns:
    
    a new Literal instance
  - timestampLiteral
```
public static Literals.LiteralImpl<java.time.LocalDateTime> timestampLiteral(java.lang.String value)
```
    Creates a timestamp type literal with the given value.
    
    Parameters:
    
    value - the timestamp literal value, must be in the format "yyyy-MM-ddTHH:mm:ss"
    
    Returns:
    
    a new Literal instance
  - stringLiteral
```
public static Literals.LiteralImpl<java.lang.String> stringLiteral(java.lang.String value)
```
    Creates a string type literal with the given value.
    
    Parameters:
    
    value - the string literal value
    
    Returns:
    
    a new Literal instance
  - varcharLiteral
```
public static Literals.LiteralImpl<java.lang.String> varcharLiteral(int length,
                                                                    java.lang.String value)
```
    Creates a varchar type literal with the given value.
    
    Parameters:
    
    value - the string literal value
    
    length - the length of the varchar
    
    Returns:
    
    a new Literal instance

Class Literals

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NULL

Method Detail

of

booleanLiteral

byteLiteral

unsignedByteLiteral

shortLiteral

unsignedShortLiteral

integerLiteral

unsignedIntegerLiteral

longLiteral

unsignedLongLiteral

floatLiteral

doubleLiteral

decimalLiteral

dateLiteral

timeLiteral

timestampLiteral

timestampLiteral

stringLiteral

varcharLiteral