Module org.tquadrat.foundation.base

Package org.tquadrat.foundation.lang.internal

Class DefaultEnumStringConverter<T extends Enum<T>>

java.lang.Object

org.tquadrat.foundation.lang.internal.DefaultEnumStringConverter<T>

Type Parameters:

T - The concrete data type that is handled by this string converter implementation.

All Implemented Interfaces:

Serializable, StringConverter<T>

@ClassVersion(sourceVersion="$Id: DefaultEnumStringConverter.java 1119 2024-03-16 09:03:57Z tquadrat $")
@API(status=INTERNAL,
     since="0.1.0")
public class DefaultEnumStringConverter<T extends Enum<T>>
extends Object
implements StringConverter<T>

The default implementation of StringConverter for types that are derived from Enum.

The implementation of fromString(CharSequence) provided here uses Class.getEnumConstants() to find the enum value:

  …
  T result = stream( m_EnumType.getEnumConstants() )
      .filter( constant -> value.equals( constant.name() ) )
      .findFirst()
      .orElseThrow( () -> new IllegalArgumentException( … );
  …

The implementation of toString(Enum) in this class will return the value of Enum.name().

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: DefaultEnumStringConverter.java 1119 2024-03-16 09:03:57Z tquadrat $

Since:

0.1.0

See Also:

• Serialized Form

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.lang.internal.DefaultEnumStringConverter"

⁠

Field Summary

Fields

Modifier and Type	Field	Description
private final Class<T>	m_EnumType	The data type of the property to set.
static final String	MSG_UnknownValue	The error message for the name of an unknown class on the command line: "Unknown/invalid value: %1$s".

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

METHOD_NAME_GetSubjectClass, METHOD_NAME_Provider

Constructor Summary

Constructors

Constructor	Description
DefaultEnumStringConverter(Class<T> enumType)	Creates a new EnumValueHandler instance.

Method Summary

Modifier and Type	Method	Description
T	fromString(CharSequence source)	Converts the given String to an object instance.
final Collection<Class<T>>	getSubjectClass()	Provides the subject class for this converter.
String	toString(T source)	Converts the given object instance to a String.

Methods inherited from class java.lang.Object

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

Field Details

MSG_UnknownValue

public static final String MSG_UnknownValue

The error message for the name of an unknown class on the command line: "Unknown/invalid value: %1$s".

See Also:

• Constant Field Values

m_EnumType

private final Class<T extends Enum<T>> m_EnumType

The data type of the property to set.

Constructor Details

DefaultEnumStringConverter

public DefaultEnumStringConverter(Class<T> enumType)

Creates a new EnumValueHandler instance.

Parameters:

enumType - The data type for the property.

Method Details

fromString

@MountPoint
public T fromString(CharSequence source)
             throws IllegalArgumentException

Converts the given String to an object instance.

Specified by:

fromString in interface StringConverter<T extends Enum<T>>

Parameters:

source - The String representation for the object instance; can be null.

Returns:

The resulting object instance; will be null if source was already null.

Throws:

IllegalArgumentException - The format of the given String is invalid and cannot be parsed into the object instance.

getSubjectClass

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

Provides the subject class for this converter.

Returns:

The subject class.

toString

@MountPoint
public String toString(T source)

Converts the given object instance to a String.

Specified by:

toString in interface StringConverter<T extends Enum<T>>

Parameters:

source - The object to convert; can be null.

Returns:

The resulting String; will be null if source was already null.