Package org.apache.sis.internal.converter

Class PathConverter<S,T>

java.lang.Object

org.apache.sis.internal.converter.ClassPair<S,T>

org.apache.sis.internal.converter.SystemConverter<S,T>

org.apache.sis.internal.converter.PathConverter<S,T>

All Implemented Interfaces:

Serializable, Function<S,T>, ObjectConverter<S,T>

Direct Known Subclasses:

PathConverter.FilePath, PathConverter.FileURI, PathConverter.FileURL, PathConverter.PathFile, PathConverter.PathURI, PathConverter.PathURL, PathConverter.URI_URL, PathConverter.URIFile, PathConverter.URIPath, PathConverter.URL_URI, PathConverter.URLFile, PathConverter.URLPath

abstract class PathConverter<S,T>
extends SystemConverter<S,T>

Handles conversions between Path, File, URI and URL objects.

Immutability and thread safety

This base class and all inner classes are immutable, and thus inherently thread-safe.

Since:

0.3

Version:

0.7

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	PathConverter.FilePath	Converter from File to Path.
static final class	PathConverter.FileURI	Converter from File to URI.
static final class	PathConverter.FileURL	Converter from File to URL.
static final class	PathConverter.PathFile	Converter from Path to File.
static final class	PathConverter.PathURI	Converter from Path to URI.
static final class	PathConverter.PathURL	Converter from Path to URL.
static final class	PathConverter.URI_URL	Converter from URI to URL.
static final class	PathConverter.URIFile	Converter from URI to File.
static final class	PathConverter.URIPath	Converter from URI to Path.
static final class	PathConverter.URL_URI	Converter from URL to URI.
static final class	PathConverter.URLFile	Converter from URL to File.
static final class	PathConverter.URLPath	Converter from URL to Path.

Field Summary

Fields

Modifier and Type	Field	Description
private static final long	serialVersionUID	For cross-version compatibility.

Fields inherited from class org.apache.sis.internal.converter.ClassPair

sourceClass, targetClass

Constructor Summary

Constructors

Constructor	Description
PathConverter(Class<S> sourceClass, Class<T> targetClass)	Creates a path converter from the given source class to the given target class.

Method Summary

Modifier and Type	Method	Description
final T	apply(S source)	Converts the given path to the target type of this converter.
(package private) abstract T	doConvert(S source)	Invoked by apply(Object) for converting the given path to the target type of this converter.
final Set<FunctionProperty>	properties()	Returns the properties of this converter.

Methods inherited from class org.apache.sis.internal.converter.SystemConverter

bijective, equals, formatErrorMessage, getSourceClass, getTargetClass, inverse, readResolve, unique

Methods inherited from class org.apache.sis.internal.converter.ClassPair

cast, hashCode, parentSource, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.function.Function

andThen, compose

Field Details

serialVersionUID

private static final long serialVersionUID

For cross-version compatibility.

See Also:

• Constant Field Values

Constructor Details

PathConverter

PathConverter(Class<S> sourceClass,
 Class<T> targetClass)

Creates a path converter from the given source class to the given target class.

Method Details

properties

public final Set<FunctionProperty> properties()

Returns the properties of this converter.

Returns:

the manners in which source values are mapped to target values. May be an empty set, but never null.

apply

public final T apply(S source)
              throws UnconvertibleObjectException

Converts the given path to the target type of this converter. This method verifies that the given path is non-null, then delegates to doConvert(Object).

Parameters:

source - the path to convert, or null.

Returns:

the converted value, or null if the given path was null.

Throws:

UnconvertibleObjectException - if an error occurred during the conversion.

doConvert

abstract T doConvert(S source)
              throws Exception

Invoked by apply(Object) for converting the given path to the target type of this converter.

Parameters:

source - the path to convert, guaranteed to be non-null.

Returns:

the converted path.

Throws:

Exception - if an error occurred during the conversion.