Module litebridge.orm

Package org.litebridgedb.orm.expression.function.scalar

Record Class SubstringSpec

java.lang.Object

java.lang.Record

org.litebridgedb.orm.expression.function.scalar.SubstringSpec

Record Components:

target - Target column expression to extract characters from.

start - The starting position. The first character of a database string is always 1.

length - The number of characters to return. If null, the function extracts everything from the start position to the end of the text.

All Implemented Interfaces:

ColumnExpressionSpec, DelegateExpressionSpec, ExpressionSpec, StringTODelegateExpressionSpec, TypeOverride<String>, TypeOverrideExpressionSpec<String>

public record SubstringSpec(ColumnExpressionSpec target, int start, @Nullable Integer length)
extends Record
implements StringTODelegateExpressionSpec

SUBSTRING(): Returns a substring of a column's text.

Constructor Summary

Constructors

Constructor	Description
SubstringSpec(ColumnExpressionSpec target, int start, @Nullable Integer length)	Creates an instance of a SubstringSpec record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
@Nullable Integer	length()	Returns the value of the length record component.
int	start()	Returns the value of the start record component.
ColumnExpressionSpec	target()	Returns the value of the target record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.litebridgedb.orm.expression.DelegateExpressionSpec

getColumn, setColumn

Methods inherited from interface org.litebridgedb.orm.expression.StringTODelegateExpressionSpec

returnType

Constructor Details

SubstringSpec

public SubstringSpec(ColumnExpressionSpec target,
 int start,
 @Nullable Integer length)

Creates an instance of a SubstringSpec record class.

Parameters:

target - the value for the target record component

start - the value for the start record component

length - the value for the length record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

target

public ColumnExpressionSpec target()

Returns the value of the target record component.

Specified by:

target in interface DelegateExpressionSpec

Returns:

the value of the target record component

start

public int start()

Returns the value of the start record component.

Returns:

the value of the start record component

length

public @Nullable Integer length()

Returns the value of the length record component.

Returns:

the value of the length record component