Module org.tquadrat.foundation.util

Package org.tquadrat.foundation.util.stringconverter

Class BooleanStringConverter

java.lang.Object

org.tquadrat.foundation.util.stringconverter.BooleanStringConverter

All Implemented Interfaces:

Serializable, StringConverter<Boolean>

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

An implementation of StringConverter for boolean and Boolean values.

The method fromString(CharSequence) will accept the String "true", irrespective of case, for the value true, and any other String for false (including the empty String!), while Object.toString() will only return "true" or "false" (or null if the input is null). This behaviour can be changed by providing different implementations for translate(CharSequence) and toString(Boolean).

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

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

Since:

0.0.6

See Also:

• Boolean.valueOf(String)
• Serialized Form

UML Diagram

⁠

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

⁠

Field Summary

Fields

Modifier and Type	Field	Description
static final BooleanStringConverter	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
BooleanStringConverter()	Creates a new instance of BooleanStringConverter.

Method Summary

Modifier and Type	Method	Description
Boolean	fromString(CharSequence source)
final Collection<Class<?>>	getSubjectClass()	Provides the subject class for this converter.
static final BooleanStringConverter	provider()	This method is used by the ServiceLoader to obtain the instance for this StringConverter implementation.
String	toString(Boolean source)
protected CharSequence	translate(CharSequence source)	Translates the given String to either "true" or "false".

Methods inherited from class java.lang.Object

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

Field Details

INSTANCE

public static final BooleanStringConverter INSTANCE

An instance of this class.

Constructor Details

BooleanStringConverter

public BooleanStringConverter()

Creates a new instance of BooleanStringConverter.

Method Details

fromString

public Boolean fromString(CharSequence source)

Specified by:

fromString in interface StringConverter<Boolean>

getSubjectClass

public final Collection<Class<?>> getSubjectClass()

Provides the subject class for this converter.

Returns:

The subject class.

provider

public static final BooleanStringConverter provider()

This method is used by the ServiceLoader to obtain the instance for this StringConverter implementation.

Returns:

The instance for this StringConverter implementation.

toString

@MountPoint
public String toString(Boolean source)

Specified by:

toString in interface StringConverter<Boolean>

translate

@MountPoint
protected CharSequence translate(CharSequence source)

Translates the given String to either "true" or "false". The default implementation just returns the argument.

If this method will be implemented differently, it is no longer guaranteed that

toString( fromString( s ) ) == s

yields true for all s.

Parameters:

source - The original text; can be null.

Returns:

The translated source; can be null if source was already null.