Value (cds4j:api 1.13.1 API)

All Superinterfaces:

CqnToken, CqnValue, JSONizable, Orderable

All Known Subinterfaces:

ElementRef<T>, FunctionCall<T>, Literal<T>, Parameter<T>
```
public interface Value<T>
extends CqnValue, Orderable
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`CqnSelectListValue`	`as(String alias)`
`Predicate`	`between(T low, T high)` Creates a between predicate that tests if this value is within a closed interval with given bounds
`Predicate`	`between(T low, Value<T> high)` Creates a between predicate that tests if this value is within a closed interval with given bounds
`Predicate`	`between(Value<T> low, T high)` Creates a between predicate that tests if this value is within a closed interval with given bounds
`Predicate`	`between(Value<T> low, Value<T> high)` Creates a between predicate that tests if this value is within a closed interval with given bounds
`default <U> Value<U>`	`cast(Class<U> javaType)` Deprecated.
`default <U> Value<U>`	`cast(String cdsType)` Deprecated.
`Predicate`	`contains(String substring)` Creates a predicate that tests whether this string value contains a given substring
`Predicate`	`contains(Value<String> substring)` Creates a predicate that tests whether this string value contains a given substring
`Predicate`	`contains(Value<String> substring, boolean caseInsensitive)` Creates a predicate that tests whether this string value contains a given substring
`Value<T>`	`dividedBy(T v)` Creates an expression that divides this numeric value by a given divisor
`Value<T>`	`dividedBy(Value<T> v)` Creates an expression that divides this numeric value by a given divisor
`Predicate`	`endsWith(String suffix)` Creates a predicate that tests whether this string value ends with a given suffix
`Predicate`	`endsWith(Value<String> suffix)` Creates a predicate that tests whether this string value ends with a given suffix
`Predicate`	`eq(T v)` Creates a comparison predicate that tests if this value is equal to a given value
`Predicate`	`eq(Value<T> v)` Creates a comparison predicate that tests if this value is equal to a given value
`Predicate`	`func(String functionName, Value<?>... additional)` Creates a predicate that applies a given function to this values and optional additional values
`Predicate`	`ge(T v)` Creates a comparison predicate that tests if this value is greater than or equal to a given value
`Predicate`	`ge(Value<T> v)` Creates a comparison predicate that tests if this value is greater than or equal to a given value
`Predicate`	`gt(T v)` Creates a comparison predicate that tests if this value is greater than a given value
`Predicate`	`gt(Value<T> v)` Creates a comparison predicate that tests if this value is greater than a given value
`Predicate`	`in(Iterable<Value<? extends T>> ts)` Creates an IN predicate that tests if this value is equal to any value in a given list
`Predicate`	`in(List<? extends T> ts)` Creates an IN predicate that tests if this value is equal to any value in a given list
`Predicate`	`in(T... vs)` Creates an IN predicate that tests if this value is equal to any value in a given list
`Predicate`	`in(Value<T>... ts)` Creates an IN predicate that tests if this value is equal to any value in a given list
`Predicate`	`isNotNull()` Creates a predicate that tests if this value is not null
`Predicate`	`isNull()` Creates a predicate that tests if this value is null
`Predicate`	`le(T v)` Creates a comparison predicate that tests if this value is less than or equal to a given value
`Predicate`	`le(Value<T> v)` Creates a comparison predicate that tests if this value is less than or equal to a given value
`Predicate`	`lt(T v)` Creates a comparison predicate that tests if this value is less than a given value
`Predicate`	`lt(Value<T> v)` Creates a comparison predicate that tests if this value is less than a given value
`Value<T>`	`minus(T v)` Creates an expression that subtracts a given subtrahend from this numeric value
`Value<T>`	`minus(Value<T> v)` Creates an expression that subtracts a given subtrahend from this numeric value
`Predicate`	`ne(T v)` Creates a comparison predicate that tests if this value is not equal to a given value
`Predicate`	`ne(Value<T> v)` Creates a comparison predicate that tests if this value is not equal to a given value
`Predicate`	`plain(Object... p)`
`Value<T>`	`plus(T v)` Creates an expression that adds a given summand to this numeric value
`Value<T>`	`plus(Value<T> v)` Creates an expression that adds a given summand to this numeric value
`Predicate`	`startsWith(String prefix)` Creates a predicate that tests whether this string value starts with a given prefix
`Predicate`	`startsWith(Value<String> prefix)` Creates a predicate that tests whether this string value starts with a given prefix
`Value<String>`	`substring(int start)` Creates an expression for substring extraction from this string value.
`Value<String>`	`substring(int start, int length)` Creates an expression for substring extraction from this string value.
`Value<String>`	`substring(Value<Integer> start)` Creates an expression for substring extraction from this string value.
`Value<String>`	`substring(Value<Integer> start, Value<Integer> length)` Creates an expression for substring extraction from this value.
`Value<T>`	`times(T v)` Creates an expression that multiplies this numeric value with a given factor
`Value<T>`	`times(Value<T> v)` Creates an expression that multiplies this numeric value with a given factor
`Value<String>`	`toLower()` Creates an expression for converting this string value to lower case using the rules of the underlying data store.
`Value<String>`	`toUpper()` Creates an expression for converting this string value to upper case using the rules of the underlying data store.
`<U> Value<U>`	`type(CdsBaseType cdsType)`
`<U> Value<U>`	`type(Class<U> javaType)`
`<U> Value<U>`	`type(String cdsType)`
`CqnSelectListValue`	`withoutAlias()`

Methods inherited from interface com.sap.cds.ql.cqn.CqnValue
as, asExpression, asFunction, asLiteral, asNullValue, asParameter, asPlain, asRef, isExpression, isFunction, isLiteral, isNullValue, isParameter, isPlain, isRef, type

Methods inherited from interface com.sap.cds.ql.cqn.CqnToken
accept, tokens

Methods inherited from interface com.sap.cds.JSONizable
toJson

Methods inherited from interface com.sap.cds.ql.Orderable
asc, desc

- Method Detail
 - plus
```
Value<T> plus(T v)
```
 Creates an expression that adds a given summand to this numeric value
 
 Parameters:
 
 v - the summand
 
 Returns:
 
 expression for the addition
 - plus
```
Value<T> plus(Value<T> v)
```
 Creates an expression that adds a given summand to this numeric value
 
 Parameters:
 
 v - the summand
 
 Returns:
 
 expression for the addition
 - minus
```
Value<T> minus(T v)
```
 Creates an expression that subtracts a given subtrahend from this numeric value
 
 Parameters:
 
 v - the subtrahend
 
 Returns:
 
 expression for the subtraction
 - minus
```
Value<T> minus(Value<T> v)
```
 Creates an expression that subtracts a given subtrahend from this numeric value
 
 Parameters:
 
 v - the subtrahend
 
 Returns:
 
 expression for the subtraction
 - times
```
Value<T> times(T v)
```
 Creates an expression that multiplies this numeric value with a given factor
 
 Parameters:
 
 v - the factor
 
 Returns:
 
 expression for the multiplication
 - times
```
Value<T> times(Value<T> v)
```
 Creates an expression that multiplies this numeric value with a given factor
 
 Parameters:
 
 v - the factor
 
 Returns:
 
 expression for the multiplication
 - dividedBy
```
Value<T> dividedBy(T v)
```
 Creates an expression that divides this numeric value by a given divisor
 
 Parameters:
 
 v - the divisor
 
 Returns:
 
 expression for the division
 - dividedBy
```
Value<T> dividedBy(Value<T> v)
```
 Creates an expression that divides this numeric value by a given divisor
 
 Parameters:
 
 v - the divisor
 
 Returns:
 
 expression for the division
 - substring
```
Value<String> substring(Value<Integer> start,
 Value<Integer> length)
```
 Creates an expression for substring extraction from this value. Extracts a substring of given length starting at a specified position. First position is 0.
 
 Parameters:
 
 start - the start position
 
 length - the number of characters that you want to extract
 
 Returns:
 
 expression for substring extraction
 - substring
```
Value<String> substring(int start,
 int length)
```
 Creates an expression for substring extraction from this string value. Extracts a substring of given length starting at a specified position. First position is 0.
 
 Parameters:
 
 start - the start position
 
 length - the number of characters that you want to extract
 
 Returns:
 
 expression for substring extraction
 - substring
```
Value<String> substring(Value<Integer> start)
```
 Creates an expression for substring extraction from this string value. Extracts a substring starting at a specified position extending to the end of the string. First position is 0.
 
 Parameters:
 
 start - the start position
 
 Returns:
 
 the expression for substring extraction
 - substring
```
Value<String> substring(int start)
```
 Creates an expression for substring extraction from this string value. Extracts a substring starting at a specified position extending to the end of the string. First position is 0.
 
 Parameters:
 
 start - the start position
 
 Returns:
 
 the expression for substring extraction
 - toUpper
```
Value<String> toUpper()
```
 Creates an expression for converting this string value to upper case using the rules of the underlying data store.
 
 Returns:
 
 the String value in UpperCase
 - toLower
```
Value<String> toLower()
```
 Creates an expression for converting this string value to lower case using the rules of the underlying data store.
 
 Returns:
 
 the String value in LowerCase
 - isNull
```
Predicate isNull()
```
 Creates a predicate that tests if this value is null
 
 Returns:
 
 the predicate for the null test
 - isNotNull
```
Predicate isNotNull()
```
 Creates a predicate that tests if this value is not null
 
 Returns:
 
 the predicate for the not null test
 - eq
```
Predicate eq(T v)
```
 Creates a comparison predicate that tests if this value is equal to a given value
 
 Parameters:
 
 v - the value to compare with
 
 Returns:
 
 the comparison predicate
 - eq
```
Predicate eq(Value<T> v)
```
 Creates a comparison predicate that tests if this value is equal to a given value
 
 Parameters:
 
 v - the value to compare with
 
 Returns:
 
 the comparison predicate
 - ne
```
Predicate ne(T v)
```
 Creates a comparison predicate that tests if this value is not equal to a given value
 
 Parameters:
 
 v - the value to compare with
 
 Returns:
 
 the comparison predicate
 - ne
```
Predicate ne(Value<T> v)
```
 Creates a comparison predicate that tests if this value is not equal to a given value
 
 Parameters:
 
 v - the value to compare with
 
 Returns:
 
 the comparison predicate
 - gt
```
Predicate gt(T v)
```
 Creates a comparison predicate that tests if this value is greater than a given value
 
 Parameters:
 
 v - the value to compare with
 
 Returns:
 
 the comparison predicate
 - gt
```
Predicate gt(Value<T> v)
```
 Creates a comparison predicate that tests if this value is greater than a given value
 
 Parameters:
 
 v - the value to compare with
 
 Returns:
 
 the comparison predicate
 - ge
```
Predicate ge(T v)
```
 Creates a comparison predicate that tests if this value is greater than or equal to a given value
 
 Parameters:
 
 v - the value to compare with
 
 Returns:
 
 the comparison predicate
 - ge
```
Predicate ge(Value<T> v)
```
 Creates a comparison predicate that tests if this value is greater than or equal to a given value
 
 Parameters:
 
 v - the value to compare with
 
 Returns:
 
 the comparison predicate
 - lt
```
Predicate lt(T v)
```
 Creates a comparison predicate that tests if this value is less than a given value
 
 Parameters:
 
 v - the value to compare with
 
 Returns:
 
 the comparison predicate
 - lt
```
Predicate lt(Value<T> v)
```
 Creates a comparison predicate that tests if this value is less than a given value
 
 Parameters:
 
 v - the value to compare with
 
 Returns:
 
 the comparison predicate
 - le
```
Predicate le(T v)
```
 Creates a comparison predicate that tests if this value is less than or equal to a given value
 
 Parameters:
 
 v - the value to compare with
 
 Returns:
 
 the comparison predicate
 - le
```
Predicate le(Value<T> v)
```
 Creates a comparison predicate that tests if this value is less than or equal to a given value
 
 Parameters:
 
 v - the value to compare with
 
 Returns:
 
 the comparison predicate
 - between
```
Predicate between(T low,
 T high)
```
 Creates a between predicate that tests if this value is within a closed interval with given bounds
 
 Parameters:
 
 low - the lower bound
 
 high - the upper bound
 
 Returns:
 
 the between predicate
 - between
```
Predicate between(Value<T> low,
 T high)
```
 Creates a between predicate that tests if this value is within a closed interval with given bounds
 
 Parameters:
 
 low - the lower bound
 
 high - the upper bound
 
 Returns:
 
 the between predicate
 - between
```
Predicate between(T low,
 Value<T> high)
```
 Creates a between predicate that tests if this value is within a closed interval with given bounds
 
 Parameters:
 
 low - the lower bound
 
 high - the upper bound
 
 Returns:
 
 the between predicate
 - between
```
Predicate between(Value<T> low,
 Value<T> high)
```
 Creates a between predicate that tests if this value is within a closed interval with given bounds
 
 Parameters:
 
 low - the lower bound
 
 high - the upper bound
 
 Returns:
 
 the between predicate
 - in
```
Predicate in(T... vs)
```
 Creates an IN predicate that tests if this value is equal to any value in a given list
 
 Parameters:
 
 vs - the given values
 
 Returns:
 
 the IN predicate for the in list test
 - in
```
Predicate in(List<? extends T> ts)
```
 Creates an IN predicate that tests if this value is equal to any value in a given list
 
 Parameters:
 
 ts - the given values
 
 Returns:
 
 the IN predicate for the in list test
 - in
```
Predicate in(Value<T>... ts)
```
 Creates an IN predicate that tests if this value is equal to any value in a given list
 
 Parameters:
 
 ts - the given values
 
 Returns:
 
 the IN predicate for the in list test
 - in
```
Predicate in(Iterable<Value<? extends T>> ts)
```
 Creates an IN predicate that tests if this value is equal to any value in a given list
 
 Parameters:
 
 ts - the given values
 
 Returns:
 
 the IN predicate for the in list test
 - plain
```
Predicate plain(Object... p)
```
 - func
```
Predicate func(String functionName,
 Value<?>... additional)
```
 Creates a predicate that applies a given function to this values and optional additional values
 
 Parameters:
 
 functionName - the function name
 
 additional - the additional values
 
 Returns:
 
 the function call
 - contains
```
Predicate contains(String substring)
```
 Creates a predicate that tests whether this string value contains a given substring
 
 Parameters:
 
 substring - the substring
 
 Returns:
 
 the predicate for the containment test
 - contains
```
Predicate contains(Value<String> substring)
```
 Creates a predicate that tests whether this string value contains a given substring
 
 Parameters:
 
 substring - the substring
 
 Returns:
 
 the predicate for the containment test
 - contains
```
Predicate contains(Value<String> substring,
 boolean caseInsensitive)
```
 Creates a predicate that tests whether this string value contains a given substring
 
 Parameters:
 
 substring - the substring
 
 caseInsensitive - whether the test should be case insensitive
 
 Returns:
 
 the predicate for the containment test
 - startsWith
```
Predicate startsWith(String prefix)
```
 Creates a predicate that tests whether this string value starts with a given prefix
 
 Parameters:
 
 prefix - the prefix
 
 Returns:
 
 the predicate for the starts-with test
 - startsWith
```
Predicate startsWith(Value<String> prefix)
```
 Creates a predicate that tests whether this string value starts with a given prefix
 
 Parameters:
 
 prefix - the prefix
 
 Returns:
 
 the predicate for the starts-with test
 - endsWith
```
Predicate endsWith(String suffix)
```
 Creates a predicate that tests whether this string value ends with a given suffix
 
 Parameters:
 
 suffix - the suffix
 
 Returns:
 
 the predicate for the ends-with test
 - endsWith
```
Predicate endsWith(Value<String> suffix)
```
 Creates a predicate that tests whether this string value ends with a given suffix
 
 Parameters:
 
 suffix - the suffix
 
 Returns:
 
 the predicate for the ends-with test
 - as
```
CqnSelectListValue as(String alias)
```
 - withoutAlias
```
CqnSelectListValue withoutAlias()
```
 - type
```
 Value type(Class javaType)
```
 - type
```
 Value type(String cdsType)
```
 - type
```
 Value type(CdsBaseType cdsType)
```
 - cast
```
@Deprecated
default  Value cast(Class javaType)
```
 Deprecated.
 - cast
```
@Deprecated
default  Value cast(String cdsType)
```
 Deprecated.

Interface Value<T>

Method Summary

Methods inherited from interface com.sap.cds.ql.cqn.CqnValue

Methods inherited from interface com.sap.cds.ql.cqn.CqnToken

Methods inherited from interface com.sap.cds.JSONizable

Methods inherited from interface com.sap.cds.ql.Orderable

Method Detail

plus

plus

minus

minus

times

times

dividedBy

dividedBy

substring

substring

substring

substring

toUpper

toLower

isNull

isNotNull

eq

eq

ne

ne

gt

gt

ge

ge

lt

lt

le

le

between

between

between

between

in

in

in

in

plain

func

contains

contains

contains

startsWith

startsWith

endsWith

endsWith

as

withoutAlias

type

type

type

cast

cast