Module org.tquadrat.foundation.util

Package org.tquadrat.foundation.util.stringconverter

Class EncodedURLStringConverter

java.lang.Object

org.tquadrat.foundation.util.stringconverter.URLStringConverter

org.tquadrat.foundation.util.stringconverter.EncodedURLStringConverter

All Implemented Interfaces:

Serializable, StringConverter<URL>

@ClassVersion(sourceVersion="$Id: EncodedURLStringConverter.java 1080 2024-01-03 11:05:21Z tquadrat $")
@API(status=STABLE,
     since="0.1.0")
public final class EncodedURLStringConverter
extends URLStringConverter

An implementation of StringConverter for URL values. Different from URLStringConverter, this implementation expects an "application/x-www-form-url" encoded String as the argument for fromString(CharSequence) and returns such a String from toString(URL).

The method fromString(CharSequence) will use URLDecoder.decode(String, Charset) to get the decode URL String, then it calls URLStringConverter.fromString(CharSequence) to create a URL instance from it.

toString(URL) uses URLStringConverter.toString(URL) to get a String out of the URL and encodes it with a call to URLEncoder.encode(String, Charset).

Based on the World Wide Web Consortium Recommendation both methods (fromString() and toString()) are using UTF-8 as the charset argument.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: EncodedURLStringConverter.java 1080 2024-01-03 11:05:21Z tquadrat $

Since:

0.1.0

See Also:

• Serialized Form

UML Diagram

⁠

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

⁠

Field Summary

Fields

Modifier and Type	Field	Description
static final EncodedURLStringConverter	INSTANCE	An instance of this class.
private final Charset	m_Encoding	The character encoding that is used at default.

Fields inherited from class org.tquadrat.foundation.util.stringconverter.URLStringConverter

MSG_InvalidURL

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

METHOD_NAME_GetSubjectClass, METHOD_NAME_Provider

Constructor Summary

Constructors

Constructor	Description
EncodedURLStringConverter()	Creates a new instance of EncodedURLStringConverter that uses UTF-8 as the default encoding.
EncodedURLStringConverter(Charset encoding)	Creates a new instance of EncodedURLStringConverter that uses the given encoding as the default encoding.

Method Summary

Modifier and Type	Method	Description
URL	fromString(CharSequence source)
final URL	fromString(CharSequence source, Charset charset)	Converts the given String that contains a valid application/x-www-form-url encoded URL into an instance of URL, using the provided character encoding.
final String	toString(URL source)
final String	toString(URL source, Charset charset)	Converts the given URL, into an application/x-www-form-url encoded String representation, using the provided character encoding.

Methods inherited from class org.tquadrat.foundation.util.stringconverter.URLStringConverter

getSubjectClass, provider

Methods inherited from class java.lang.Object

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

Field Details

m_Encoding

private final Charset m_Encoding

The character encoding that is used at default.

INSTANCE

public static final EncodedURLStringConverter INSTANCE

An instance of this class.

This instance uses UTF-8 as the default encoding.

Constructor Details

EncodedURLStringConverter

public EncodedURLStringConverter()

Creates a new instance of EncodedURLStringConverter that uses UTF-8 as the default encoding.

EncodedURLStringConverter

public EncodedURLStringConverter(Charset encoding)

Creates a new instance of EncodedURLStringConverter that uses the given encoding as the default encoding.

Parameters:

encoding - The default character encoding.

See Also:

• URLEncoder.encode(String, Charset)
• URLDecoder.decode(String, Charset)

Method Details

fromString

public final URL fromString(CharSequence source,
 Charset charset)
                     throws IllegalArgumentException

Converts the given String that contains a valid application/x-www-form-url encoded URL into an instance of URL, using the provided character encoding.

Parameters:

source - The source; can be null.

charset - The character encoding of the String.

Returns:

The respective URL, or null if the source was already null.

Throws:

IllegalArgumentException - The source was either not a valid URL, or the encoding was invalid.

fromString

public URL fromString(CharSequence source)
               throws IllegalArgumentException

This method uses the default character encoding as set by the constructor.

Specified by:

fromString in interface StringConverter<URL>

Overrides:

fromString in class URLStringConverter

Throws:

IllegalArgumentException

toString

public final String toString(URL source,
 Charset charset)

Converts the given URL, into an application/x-www-form-url encoded String representation, using the provided character encoding.

Parameters:

source - The source; can be null.

charset - The character encoding for the String.

Returns:

The respective String representation, or null if the source was already null.

Throws:

IllegalArgumentException - The source was either not a valid URL, or the encoding was invalid.

toString

public final String toString(URL source)

This method uses the default character encoding as set by the constructor.

Specified by:

toString in interface StringConverter<URL>

Overrides:

toString in class URLStringConverter