Module org.kink_lang.kink

Package org.kink_lang.kink

Class StrVal

java.lang.Object

org.kink_lang.kink.HostResultCore

org.kink_lang.kink.Val

org.kink_lang.kink.StrVal

All Implemented Interfaces:

Comparable<StrVal>, HostResult, Just<StrVal>, OpResult<StrVal>

public class StrVal
extends Val
implements Comparable<StrVal>, Just<StrVal>

A str val.

See Also:

• Vm.str

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StrVal.Helper	The helper of str vals.

Field Summary

Fields inherited from class org.kink_lang.kink.Val

vm

Method Summary

Modifier and Type	Method	Description
int	compareTo(StrVal arg)	Compares two str values in the order of code points.
OpResult<StrVal>	concat(StrVal tail)	Returns a str value concatenating this and tail.
boolean	equals(Object arg)
int	hashCode()
boolean	isEmpty()	Returns whether the string is empty.
StrVal	just()	Returns this.
String	string()	Returns the string.
String	toString()

Methods inherited from class org.kink_lang.kink.Val

getVar, getVarSymHandleSet, hasVar, makeHostResultCore, setVar

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kink_lang.kink.op.Just

justOrNull

Method Details

string

public String string()

Returns the string.

Returns:

the string.

just

public StrVal just()

Returns this.

Specified by:

just in interface Just<StrVal>

Returns:

this.

isEmpty

public boolean isEmpty()

Returns whether the string is empty.

Returns:

whether the string is empty.

concat

public OpResult<StrVal> concat(StrVal tail)

Returns a str value concatenating this and tail. If the result size overflows, the method returns OpError.

Parameters:

tail - str val to concatenate.

Returns:

a str value concatenating this and tail.

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object arg)

Overrides:

equals in class Object

compareTo

public int compareTo(StrVal arg)

Compares two str values in the order of code points.

Specified by:

compareTo in interface Comparable<StrVal>

Parameters:

arg - the str value to be compared.

Returns:

0 if two strings are equal; less than 0 if this string is smaller; otherwise greater than 0.