org.esa.snap.core.util

Class ServiceFinder

java.lang.Object

org.esa.snap.core.util.ServiceFinder

public class ServiceFinder
extends Object

A finder for service provider interface (SPI) registries.

Since:

SNAP 2.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServiceFinder.Module The module containing the services.

Constructor Summary

Constructors

Constructor and Description
ServiceFinder(String serviceName)

Method Summary

Modifier and Type	Method and Description
void	addSearchPath(Path path) Adds a search (directory) path.
void	addSearchPaths(Path... paths) Adds search (directory) paths.
void	addSearchPathsFromPreferences(String key) Adds search paths from user preferences.
void	addSearchPathsFromPreferences(String configName, String key) Adds search paths from user preferences.
List<ServiceFinder.Module>	findServices() Finds services based on the current search path configuration.
void	searchClassPath(boolean searchClassPath)

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceFinder

public ServiceFinder(String serviceName)

Method Detail

addSearchPath

public void addSearchPath(Path path)

Adds a search (directory) path.

Parameters:

path - A search path.

addSearchPaths

public void addSearchPaths(Path... paths)

Adds search (directory) paths.

Parameters:

paths - The search paths.

addSearchPathsFromPreferences

public void addSearchPathsFromPreferences(String configName,
                                          String key)

Adds search paths from user preferences. The value is be a colon- (Unix) or semicolon-separated list of (directory) paths.

Parameters:

configName - The configuration name.

key - The user preferences key.

addSearchPathsFromPreferences

public void addSearchPathsFromPreferences(String key)

Adds search paths from user preferences. The value is be a colon- (Unix) or semicolon-separated list of (directory) paths.

Parameters:

key - The user preferences key.

searchClassPath

public void searchClassPath(boolean searchClassPath)

Parameters:

searchClassPath - true, if the Java classpath shall be searched as well

findServices

public List<ServiceFinder.Module> findServices()

Finds services based on the current search path configuration.

Returns:

List of modules providing the services.