Module org.tquadrat.foundation.util

Package org.tquadrat.foundation.util.stringconverter

Class FileStringConverter

java.lang.Object

org.tquadrat.foundation.util.stringconverter.FileStringConverter

All Implemented Interfaces:

Serializable, StringConverter<File>

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

An implementation of StringConverter for File values.

The file or folder that will be identified by the respective File object do not need to exist nor is it guaranteed that it can be accessed or create through the current user.

File names will not be normalised or canonicalized.

A file name of only blanks will be accepted as valid, while the empty String will cause an IllegalArgumentException.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

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

Since:

0.0.6

See Also:

• Serialized Form

UML Diagram

⁠

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

⁠

Field Summary

Fields

Modifier and Type	Field	Description
static final FileStringConverter	INSTANCE	An instance of this class.
static final String	MSG_InvalidFileName	The error message for an invalid file name "\'%s\' cannot be parsed as a valid file name".

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

METHOD_NAME_GetSubjectClass, METHOD_NAME_Provider

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Details

MSG_InvalidFileName

public static final String MSG_InvalidFileName

The error message for an invalid file name "\'%s\' cannot be parsed as a valid file name".

See Also:

• Constant Field Values

INSTANCE

public static final FileStringConverter INSTANCE

An instance of this class.

Constructor Details

FileStringConverter

public FileStringConverter()

Creates a new instance of FileStringConverter.

Method Details

fromString

public final File fromString(CharSequence source)
                      throws IllegalArgumentException

Specified by:

fromString in interface StringConverter<File>

Throws:

IllegalArgumentException

provider

public static final FileStringConverter 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(File source)

Specified by:

toString in interface StringConverter<File>