Module org.tquadrat.foundation.util

Package org.tquadrat.foundation.util.stringconverter

Class ClassStringConverter

java.lang.Object

org.tquadrat.foundation.util.stringconverter.ClassStringConverter

All Implemented Interfaces:

Serializable, StringConverter<Class<?>>

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

An implementation of StringConverter for Class values.

The method fromString(CharSequence) will use Class.forName(String, boolean, ClassLoader) to load the class with the given name. This means that the conversion may fail even for an otherwise valid class name when the respective class is not on the CLASSPATH or otherwise loadable.

It uses the ClassLoader that was used to load the caller for this method, and the boolean argument will be set to false, meaning that the class will not be initialised if not loaded previously.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

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

Since:

0.0.6

See Also:

• Class.forName(String, boolean, ClassLoader)
• JavaUtils.getCallersClassLoader()
• Serialized Form

UML Diagram

⁠

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

⁠

Field Summary

Fields

Modifier and Type	Field	Description
static final ClassStringConverter	INSTANCE	An instance of this class.
static final String	MSG_UnknownClass	The error message for the name of an unknown class on the command line: "\'%s\' cannot be parsed to the name of a known Java class".

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

METHOD_NAME_GetSubjectClass, METHOD_NAME_Provider

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
final Class<?>	fromString(CharSequence source)
static final ClassStringConverter	provider()	This method is used by the ServiceLoader to obtain the instance for this StringConverter implementation.
final String	toString(Class<?> source)

Methods inherited from class java.lang.Object

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

Field Details

MSG_UnknownClass

public static final String MSG_UnknownClass

The error message for the name of an unknown class on the command line: "\'%s\' cannot be parsed to the name of a known Java class".

See Also:

• Constant Field Values

INSTANCE

public static final ClassStringConverter INSTANCE

An instance of this class.

Constructor Details

ClassStringConverter

public ClassStringConverter()

Creates a new instance of ClassStringConverter.

Method Details

fromString

public final Class<?> fromString(CharSequence source)
                          throws IllegalArgumentException

Specified by:

fromString in interface StringConverter<Class<?>>

Throws:

IllegalArgumentException

provider

public static final ClassStringConverter provider()

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

Returns:

The instance for this StringConverter implementation.

toString

public final String toString(Class<?> source)

Specified by:

toString in interface StringConverter<Class<?>>