Module org.tquadrat.foundation.util

Package org.tquadrat.foundation.util.stringconverter

Class TextStringConverter

java.lang.Object

org.tquadrat.foundation.util.stringconverter.TextStringConverter

All Implemented Interfaces:

Serializable, StringConverter<String>

@ClassVersion(sourceVersion="$Id: TextStringConverter.java 1060 2023-09-24 19:21:40Z tquadrat $")
@API(status=STABLE,
     since="0.1.0")
public final class TextStringConverter
extends Object
implements StringConverter<String>

An implementation of StringConverter for text values.

Although technically, a text is a String and therefore a conversion to String would be redundant (at best), semantically there is difference, and this implementation of StringConverter takes care of that.

Other than for the conversions performed by StringStringConverter, the results are not identical with the input values: a text may contain several special characters, like new lines, tabs, backspaces or form feeds. These will be translated by the toString(String) method into escape sequences, while fromString(CharSequence) will translate the escape sequences back to the special characters, according to the table below.

Special Characters and their escape sequences

Name	Code	Escape	Comment
backspace	U+0008	\b
horizontal tab	U+0009	\t
line feed	U+000A	\n	The UNIX line termination, also used in Java internally as the new-line character
form feed	U+000C	\f	Rarely used
carriage return	U+000D	\r	The Windows line termination is CRLF or \r\n
space	U+0020	\s	A space or blank will be escaped only if it is the very first or the last character of a text

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: TextStringConverter.java 1060 2023-09-24 19:21:40Z tquadrat $

Since:

0.1.0

See Also:

• Serialized Form

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.util.stringconverter.TextStringConverter"

⁠

Field Summary

Fields

Modifier and Type	Field	Description
static final TextStringConverter	INSTANCE	An instance of this class.

Fields inherited from interface org.tquadrat.foundation.lang.StringConverter

METHOD_NAME_GetSubjectClass, METHOD_NAME_Provider

Constructor Summary

Constructors

Constructor	Description
TextStringConverter()	Creates a new instance of TextStringConverter.

Method Summary

Modifier and Type	Method	Description
private final IntStream	escape(int c)	Returns the escape sequence for the given special character, or the character itself if it does not need an escape.
final String	fromString(CharSequence source)
final String	toString(String source)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

INSTANCE

public static final TextStringConverter INSTANCE

An instance of this class.

Constructor Details

TextStringConverter

public TextStringConverter()

Creates a new instance of TextStringConverter.

Method Details

escape

private final IntStream escape(int c)

Returns the escape sequence for the given special character, or the character itself if it does not need an escape.

Parameters:

c - The character.

Returns:

The escape sequence.

fromString

public final String fromString(CharSequence source)
                        throws IllegalArgumentException

Specified by:

fromString in interface StringConverter<String>

Throws:

IllegalArgumentException

toString

public final String toString(String source)

Specified by:

toString in interface StringConverter<String>