Module jakarta.data

Package jakarta.data.spi.expression.literal

Interface StringLiteral

All Superinterfaces:

ComparableExpression<Object,String>, ComparableLiteral<String>, Expression<Object,String>, Literal<String>, TextExpression<Object>

public interface StringLiteral
extends ComparableLiteral<String>, TextExpression<Object>

A literal for a String value.

Since:

1.1

Method Summary

Modifier and Type	Method	Description
static StringLiteral	of(String value)	Creates a StringLiteral that represents the given value.
String	toString()	Returns a String representing the 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

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

value

Methods inherited from interface jakarta.data.expression.TextExpression

append, append, contains, endsWith, left, length, like, like, like, like, lower, notContains, notEndsWith, notLike, notLike, notLike, notStartsWith, prepend, prepend, right, startsWith, upper

Method Details

of

static StringLiteral of(String value)

Creates a StringLiteral that represents the given value.

Parameters:

value - a String value. Must never be null.

Returns:

a StringLiteral representing the value.

Throws:

NullPointerException - if the value is null.

toString

String toString()

Returns a String representing the value. The String is the value enclosed in single quotes and with each single quote character in the value escaped with a single quote.

For example, the output of StringLiteral.of("Jakarta Data's second release").toString() is

 'Jakarta Data''s second release'
 

Specified by:

toString in interface ComparableLiteral<String>

Specified by:

toString in interface Literal<String>

Overrides:

toString in class Object

Returns:

the String value escaped and enclosed in single quotes.