net.sourceforge.nrl.parser.resolver
Interface IURIResolver

All Known Implementing Classes:
AbstractURIResolver, FileAndClasspathURIResolver

public interface IURIResolver

A resolver that can open streams and resolve references for URIs.

Implementations will provide support for different URI protocols.

Since:
1.4.9

Method Summary
 boolean isURIResolvable(URI uri)
          Determine if the given URI is resolvable i.e.
 boolean isURIResolvable(URI baseURI, String resourceURI)
          Convenience method alternative to isURIResolvable(URI, String).
 boolean isURIResolvable(URI baseURI, URI resourceURI)
          Determine if the given resourceURI is resolvable relative to the base URI i.e.
 InputStream openStream(URI uri)
          Open a stream to read a resource from a URI.
 InputStream openStream(URI baseURI, String resourceURI)
          Convenience method alternative to openStream(URI, URI).
 InputStream openStream(URI baseURI, URI resourceURI)
          Open a stream to read a resource from a URI referenced relative to a base URI.
 

Method Detail

openStream

InputStream openStream(URI uri)
                       throws ResolverException
Open a stream to read a resource from a URI.

Parameters:
uri - the URI
Returns:
the stream
Throws:
ResolverException

openStream

InputStream openStream(URI baseURI,
                       URI resourceURI)
                       throws ResolverException
Open a stream to read a resource from a URI referenced relative to a base URI.

Parameters:
baseURI - the URI
resourceURI - a URI to resolve relative to baseURI
Returns:
the stream
Throws:
ResolverException

openStream

InputStream openStream(URI baseURI,
                       String resourceURI)
                       throws ResolverException
Convenience method alternative to openStream(URI, URI).

Throws:
ResolverException

isURIResolvable

boolean isURIResolvable(URI uri)
Determine if the given URI is resolvable i.e. it is possible to read from the resource.

Parameters:
uri - the URI
Returns:
true if the URI is resolvable, false otherwise

isURIResolvable

boolean isURIResolvable(URI baseURI,
                        URI resourceURI)
Determine if the given resourceURI is resolvable relative to the base URI i.e. it is possible to read from the resource.

Parameters:
baseURI - the base URI
resourceURI - a URI to resolve relative to baseURI
Returns:
true if the URI is resolvable, false otherwise

isURIResolvable

boolean isURIResolvable(URI baseURI,
                        String resourceURI)
Convenience method alternative to isURIResolvable(URI, String).

Parameters:
baseURI - the base URI
resourceURI - a URI to resolve relative to baseURI
Returns:
true if the URI is resolvable, false otherwise


Copyright © 2006-2013. All Rights Reserved.