LocationService (SciJava Common 2.100.1 API)

All Superinterfaces:

Comparable<Prioritized>, Contextual, Disposable, HandlerService<URI,LocationResolver>, HasPluginInfo, Identifiable, Initializable, Locatable, Logged, Prioritized, PTService<LocationResolver>, RichPlugin, SciJavaPlugin, SciJavaService, Service, SingletonService<LocationResolver>, Typed<URI>, TypedService<URI,LocationResolver>, Versioned

All Known Implementing Classes:

DefaultLocationService
```
public interface LocationService
extends HandlerService<URI,LocationResolver>, SciJavaService
```
A service that allows resolving of URIs to Locations, using LocationResolver plugins for translation.

Author:

Gabriel Einsdorf

Method Summary

All Methods Instance Methods Default Methods Deprecated Methods
Modifier and Type	Method	Description
`default Class<LocationResolver>`	`getPluginType()`	Gets the type of plugins managed by this service.
`default LocationResolver`	`getResolver(URI uri)`	Deprecated. Use `HandlerService.getHandler(DT)` instead.
`default Class<URI>`	`getType()`	Gets the type associated with the object.
`default Location`	`resolve(String uriString)`	Turns the given string into a `URI`, then resolves it to a `Location`.
`default Location`	`resolve(URI uri)`	Resolves the given `URI` to a location.

Methods inherited from interface org.scijava.Contextual
context, getContext, setContext

Methods inherited from interface org.scijava.Disposable
dispose

Methods inherited from interface org.scijava.plugin.HandlerService
getHandler, getInstances, supports

Methods inherited from interface org.scijava.plugin.HasPluginInfo
getInfo, setInfo

Methods inherited from interface org.scijava.Locatable
getLocation

Methods inherited from interface org.scijava.Prioritized
compareTo, getPriority, setPriority

Methods inherited from interface org.scijava.plugin.PTService
getPlugins, getPluginService, pluginService

Methods inherited from interface org.scijava.plugin.RichPlugin
getIdentifier, log

Methods inherited from interface org.scijava.service.Service
registerEventHandlers

Methods inherited from interface org.scijava.plugin.SingletonService
create, filterInstances, getInstance, initialize, objectService

Methods inherited from interface org.scijava.plugin.TypedService
find

Methods inherited from interface org.scijava.Versioned
getVersion

- Method Detail
  - resolve
```
default Location resolve(String uriString)
                  throws URISyntaxException
```
    Turns the given string into a URI, then resolves it to a Location.
    
    Parameters:
    
    uriString - the uri to resolve
    
    Returns:
    
    the resolved Location
    
    Throws:
    
    URISyntaxException - if the URI is malformed
  - resolve
```
default Location resolve(URI uri)
                  throws URISyntaxException
```
    Resolves the given URI to a location. If the scheme part of the URI is null the path component is resolved as a local file.
    
    Parameters:
    
    uri - the uri to resolve
    
    Returns:
    
    the resolved Location or null if no resolver could be found.
    
    Throws:
    
    URISyntaxException - if the URI is malformed
  - getResolver
```
@Deprecated
default LocationResolver getResolver(URI uri)
```
    Deprecated.
    Use HandlerService.getHandler(DT) instead.
  - getPluginType
```
default Class<LocationResolver> getPluginType()
```
    Description copied from interface: PTService
    
    Gets the type of plugins managed by this service.
    
    Specified by:
    
    getPluginType in interface PTService<LocationResolver>
  - getType
```
default Class<URI> getType()
```
    Description copied from interface: Typed
    
    Gets the type associated with the object.
    
    Specified by:
    
    getType in interface Typed<URI>