Literal

java.lang.Object
- io.delta.kernel.expressions.LeafExpression
- - io.delta.kernel.expressions.Literal

All Implemented Interfaces:

Expression
```
public final class Literal
extends LeafExpression
```
A literal value.
Only supports primitive data types, see Delta Transaction Log Protocol: Primitive Types.

Field Summary

Fields
Modifier and Type Field and Description

static Literal FALSE

static Literal TRUE

Fields
Modifier and Type	Field and Description
`static Literal`	`FALSE`
`static Literal`	`TRUE`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DataType`	`dataType()`
`boolean`	`equals(java.lang.Object o)`
`java.lang.Object`	`eval(Row record)`
`int`	`hashCode()`
`static Literal`	`of(boolean value)` Create a boolean `Literal` object
`static Literal`	`of(byte value)`
`static Literal`	`of(byte[] value)`
`static Literal`	`of(java.sql.Date value)`
`static Literal`	`of(double value)`
`static Literal`	`of(float value)`
`static Literal`	`of(int value)` Create an integer `Literal` object
`static Literal`	`of(long value)` Create a long `Literal` object
`static Literal`	`of(short value)`
`static Literal`	`of(java.lang.String value)` Create a string `Literal` object
`static Literal`	`of(java.sql.Timestamp value)`
`static Literal`	`ofNull(DataType dataType)`
`java.lang.String`	`toString()`
`java.lang.Object`	`value()`

Methods inherited from class io.delta.kernel.expressions.LeafExpression
children, references

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

- Field Detail
  - TRUE
```
public static final Literal TRUE
```
  - FALSE
```
public static final Literal FALSE
```
- Method Detail
  - of
```
public static Literal of(boolean value)
```
    Create a boolean Literal object
    
    Parameters:
    
    value - boolean value
    
    Returns:
    
    a Literal with data type BooleanType
  - of
```
public static Literal of(byte value)
```
    Returns:
    
    a Literal with data type ByteType
  - of
```
public static Literal of(short value)
```
    Returns:
    
    a Literal with data type ShortType
  - of
```
public static Literal of(int value)
```
    Create an integer Literal object
    
    Parameters:
    
    value - integer value
    
    Returns:
    
    a Literal with data type IntegerType
  - of
```
public static Literal of(long value)
```
    Create a long Literal object
    
    Parameters:
    
    value - long value
    
    Returns:
    
    a Literal with data type LongType
  - of
```
public static Literal of(float value)
```
    Returns:
    
    a Literal with data type FloatType
  - of
```
public static Literal of(double value)
```
    Returns:
    
    a Literal with data type DoubleType
  - of
```
public static Literal of(java.lang.String value)
```
    Create a string Literal object
    
    Parameters:
    
    value - string value
    
    Returns:
    
    a Literal with data type StringType
  - of
```
public static Literal of(byte[] value)
```
    Returns:
    
    a Literal with data type BinaryType
  - of
```
public static Literal of(java.sql.Date value)
```
    Returns:
    
    a Literal with data type DateType
  - of
```
public static Literal of(java.sql.Timestamp value)
```
    Returns:
    
    a Literal with data type TimestampType
  - ofNull
```
public static Literal ofNull(DataType dataType)
```
    Returns:
    
    a null Literal with the given data type
  - value
```
public java.lang.Object value()
```
  - eval
```
public java.lang.Object eval(Row record)
```
    Parameters:
    
    record - the input row to evaluate.
    
    Returns:
    
    the result of evaluating this expression on the given input Row.
  - dataType
```
public DataType dataType()
```
    Returns:
    
    the DataType of the result of evaluating this expression.
  - toString
```
public java.lang.String toString()
```
    Specified by:
    
    toString in interface Expression
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    the String representation of this expression.
  - equals
```
public boolean equals(java.lang.Object o)
```
    Specified by:
    
    equals in class LeafExpression
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in class LeafExpression

Class Literal

Field Summary

Method Summary

Methods inherited from class io.delta.kernel.expressions.LeafExpression

Methods inherited from class java.lang.Object

Field Detail

TRUE

FALSE

Method Detail

of

of

of

of

of

of

of

of

of

of

of

ofNull

value

eval

dataType

toString

equals

hashCode