Module org.tquadrat.foundation.util

Package org.tquadrat.foundation.util.stringconverter

Class PathStringConverter

java.lang.Object

org.tquadrat.foundation.util.stringconverter.PathStringConverter

All Implemented Interfaces:

Serializable, StringConverter<Path>

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

An implementation of StringConverter for Path values.

The method fromString(CharSequence) uses Path.of(String, String...) to create the Path instance for the given value.

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

Names will not be normalised or canonicalized.

A path 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: PathStringConverter.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.PathStringConverter"

⁠

Field Summary

Fields

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

Method Summary

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

Methods inherited from class java.lang.Object

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

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

toString

Field Details

INSTANCE

public static final PathStringConverter INSTANCE

An instance of this class.

Constructor Details

PathStringConverter

public PathStringConverter()

Creates a new instance of PathStringConverter.

Method Details

fromString

public Path fromString(CharSequence source)
                throws IllegalArgumentException

Specified by:

fromString in interface StringConverter<Path>

Throws:

IllegalArgumentException

provider

public static final PathStringConverter provider()

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

Returns:

The instance for this StringConverter implementation.