Module org.tquadrat.foundation.fx

Package org.tquadrat.foundation.fx.util

Class FXStringConverter<T>

java.lang.Object

javafx.util.StringConverter<T>

org.tquadrat.foundation.fx.util.FXStringConverter<T>

Type Parameters:

T - The target type for the conversion.

All Implemented Interfaces:

Serializable, StringConverter<T>

@ClassVersion(sourceVersion="$Id: FXStringConverter.java 1113 2024-03-12 02:01:14Z tquadrat $")
@API(status=STABLE,
     since="0.4.3")
public final class FXStringConverter<T>
extends StringConverter<T>
implements StringConverter<T>

An implementation of org.tquadrat.foundation.lang.StringConverter (the Foundation StringConverter) that extends javafx.util.StringConverter (the JavaFX StringConverter). It delegates the transformation work to the Foundation StringConverter instance that is provided to the constructor.

To reuse an existing JavaFX StringConverter, you can use the method wrap(StringConverter).

To get just a Foundation StringConverter, you can use this code (here BigInteger is used as an example):

      final var x = new BigIntegerStringConverter();
      final var c = new GenericStringConverter<BigInteger>( s -> isNull( s ) ? null : x.fromString( s.toString() ), x::toString );
  

If you need to build a String converter from scratch that should serve both purposes, write your own class that extends javafx.util.StringConverter and implements org.tquadrat.foundation.lang.StringConverter, and then implement the methods accordingly. Keep in mind that the method signature for fromString() differs for both the abstract class and the interface because of the different argument type (String vs. CharSequence).

When a reference to an instance of ErrorDisplay is provided to the constructor, an error messsage is displayed when the fromString() conversion fails.

Note:

• The method fromString() of a JavaFX StringConverter may always return null, for each and every argument, but this is not allowed for an implementation of the method with the same name for a Foundation StringConverter.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: FXStringConverter.java 1113 2024-03-12 02:01:14Z tquadrat $

Since:

0.4.3

See Also:

• GenericStringConverter
• Serialized Form

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.fx.util.FXStringConverter"

⁠

Field Summary

Fields

Modifier and Type	Field	Description
private final Optional<ErrorDisplay>	m_ErrorDisplay	The reference to the error display.
private final UnaryOperator<String>	m_MessageComposer	The function that composes the error messsage.
private final String	m_MessageId	The message id.
private final StringConverter<T>	m_StringConverter	The Foundation StringConverter instance.

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

METHOD_NAME_GetSubjectClass, METHOD_NAME_Provider

Constructor Summary

Constructors

Constructor	Description
FXStringConverter(StringConverter<T> stringConverter)	Creates a new instance of FXStringConverter.
FXStringConverter(StringConverter<T> stringConverter, ErrorDisplay errorDisplay, UnaryOperator<String> messageComposer, String messageId)	Creates a new instance of FXStringConverter.

Method Summary

Modifier and Type	Method	Description
final T	fromString(CharSequence source)
final T	fromString(String source)
final String	toString(T source)
static final <C> FXStringConverter<C>	wrap(StringConverter<C> stringConverter)	Creates an instance of FXStringConverter from an instance of javafx.util.StringConverter.

Methods inherited from class java.lang.Object

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

Field Details

m_ErrorDisplay

private final transient Optional<ErrorDisplay> m_ErrorDisplay

The reference to the error display.

m_MessageComposer

private final transient UnaryOperator<String> m_MessageComposer

The function that composes the error messsage.

m_MessageId

private final transient String m_MessageId

The message id.

m_StringConverter

private final StringConverter<T> m_StringConverter

The Foundation StringConverter instance.

Constructor Details

FXStringConverter

public FXStringConverter(StringConverter<T> stringConverter)

Creates a new instance of FXStringConverter.

Parameters:

stringConverter - The Foundation StringConverter instance that does the work.

FXStringConverter

public FXStringConverter(StringConverter<T> stringConverter,
 ErrorDisplay errorDisplay,
 UnaryOperator<String> messageComposer,
 String messageId)

Creates a new instance of FXStringConverter.

Parameters:

stringConverter - The Foundation StringConverter instance that does the work.

errorDisplay - The reference to the error display control that should display the error messages.

messageComposer - The function that creates the error message to display.

messageId - The message id (refer to ErrorDisplay.addMessage()).

Method Details

fromString

public final T fromString(String source)

Specified by:

fromString in class StringConverter<T>

fromString

public final T fromString(CharSequence source)

Specified by:

fromString in interface StringConverter<T>

toString

public final String toString(T source)

Specified by:

toString in interface StringConverter<T>

Specified by:

toString in class StringConverter<T>

wrap

public static final <C> FXStringConverter<C> wrap(StringConverter<C> stringConverter)

Creates an instance of FXStringConverter from an instance of javafx.util.StringConverter.

Keep in mind that the implementation of the method javafx.util.StringConverter.fromString() may return null for all input arguments, but that this behaviour is not valid for an implementation of the method org.tquadrat.foundation.lang.StringConverter.fromString().

Type Parameters:

C - The subject class.

Parameters:

stringConverter - The instance of StringConverter.

Returns:

The new instance.