net.openhft.chronicle.core.values

Interface StringValue

public interface StringValue

The StringValue interface represents a reference to a String value. It provides methods to retrieve and set the String value. Implementations of this interface may handle the storage and retrieval of the String value in various formats or mediums.

The getValue method retrieves the String value and the setValue method sets the String value. The getUsingValue method retrieves the String value into a supplied StringBuilder instance, which can be beneficial in scenarios where minimizing object allocations is desirable.

The setValue method allows constraining the length of the CharSequence via the @MaxBytes annotation. This can be useful for enforcing memory constraints on the stored value.

See Also:

BooleanValue, ByteValue, CharValue, DoubleValue, FloatValue, IntValue, LongValue, ShortValue, StringValue, LongArrayValues, IntArrayValues

Method Summary

Modifier and Type	Method and Description
@NotNull StringBuilder	getUsingValue(StringBuilder stringBuilder) Retrieves the String value into a supplied StringBuilder instance.
@NotNull String	getValue() Retrieves the String value.
void	setValue(CharSequence value) Sets the String value from a CharSequence.

Method Detail

getValue

@NotNull
@NotNull String getValue()

Retrieves the String value.

Returns:

The current String value.

setValue

void setValue(@MaxBytes
              CharSequence value)

Sets the String value from a CharSequence. The maximum number of encoded bytes allowed can be constrained using the @MaxBytes annotation.

Parameters:

value - The CharSequence from which the String value is set.

getUsingValue

@NotNull
@NotNull StringBuilder getUsingValue(StringBuilder stringBuilder)

Retrieves the String value into a supplied StringBuilder instance. This is useful in scenarios where minimizing object allocations is desirable.

Parameters:

stringBuilder - The StringBuilder instance to populate with the String value.

Returns:

A StringBuilder containing the current String value.