org.geotools.gce.imagemosaic

Enum PathType

Object

Enum<PathType>

PathType

All Implemented Interfaces:

Serializable, Comparable<PathType>

public enum PathType
extends Enum<PathType>

Enum that can be use to distinguish between relative paths and absolute paths when trying to load a granuleDescriptor for a mosaic.

Author:

Simone Giannecchini, GeoSolutions SAS, Stefan Alfons Krueger (alfonx), Wikisquare.de : Support for jar:file:foo.jar/bar.properties URLs

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABSOLUTE
RELATIVE
URL

Method Summary

Modifier and Type	Method and Description
abstract URL	resolvePath(String parentLocation, String location) Resolve a path for a granuleDescriptor given the parent location and location itself.
static PathType	valueOf(String name) Returns the enum constant of this type with the specified name.
static PathType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

RELATIVE

public static final PathType RELATIVE

ABSOLUTE

public static final PathType ABSOLUTE

URL

public static final PathType URL

Method Detail

values

public static PathType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PathType c : PathType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PathType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

resolvePath

public abstract URL resolvePath(String parentLocation,
                                String location)

Resolve a path for a granuleDescriptor given the parent location and location itself.

the location can never be null, while the parent location could be null, as an instance when the path is relative.

Returns:

a File instance that points to a location which could be relative or absolute depending on the flavor of the enum where this method is applied. This method might return null in case something bad happens.