A C D F G H I L O P R S T U

A

accepts(String) - Method in class org.sapia.resource.ClasspathResourceHandler

accepts(URI) - Method in class org.sapia.resource.ClasspathResourceHandler

accepts(String) - Method in class org.sapia.resource.FileResourceHandler

accepts(URI) - Method in class org.sapia.resource.FileResourceHandler

accepts(String) - Method in interface org.sapia.resource.ResourceHandler

Returns true if this handler "recognizes" resources with the given URI.

accepts(URI) - Method in interface org.sapia.resource.ResourceHandler

accepts(String) - Method in class org.sapia.resource.UrlResourceHandler

accepts(URI) - Method in class org.sapia.resource.UrlResourceHandler

append(ResourceHandler) - Method in class org.sapia.resource.ResourceHandlerChain

Adds a resource handler to the end of the list that this instance holds.

C

children - Variable in class org.sapia.resource.test.TestIncludedObject

chopScheme(String) - Static method in class org.sapia.resource.Utils

Chops the scheme/protocol from the given URL path and returns the path without the scheme.

ClasspathResourceHandler - Class in org.sapia.resource

Handles resources on the classpath.

ClasspathResourceHandler() - Constructor for class org.sapia.resource.ClasspathResourceHandler

createConfig(String, IncludeContextFactory, ResourceCapable) - Static method in class org.sapia.resource.include.IncludeState

createContext(String, IncludeConfig) - Static method in class org.sapia.resource.include.IncludeState

This method internally creates an IncludeContext that it pushes on its internall include stack before returning it.

createInstance() - Method in interface org.sapia.resource.include.IncludeContextFactory

currentContext(String) - Static method in class org.sapia.resource.include.IncludeState

D

doInclude(InputStream, Object) - Method in class org.sapia.resource.include.IncludeContext

This method's default implementation returns the passed in stream.

doInclude(InputStream, Object) - Method in class org.sapia.resource.test.TestIncludeContext

doSelect(String) - Method in class org.sapia.resource.ResourceHandlerChain

F

FileResource - Class in org.sapia.resource

Implements a Resource over a File

FileResource(File) - Constructor for class org.sapia.resource.FileResource

FileResourceHandler - Class in org.sapia.resource

Resolves resources from the file system.

FileResourceHandler() - Constructor for class org.sapia.resource.FileResourceHandler

G

getAppKey() - Method in class org.sapia.resource.include.IncludeConfig

getCanonicalUri() - Method in class org.sapia.resource.include.IncludeContext

getConfig() - Method in class org.sapia.resource.include.IncludeContext

getFactory() - Method in class org.sapia.resource.include.IncludeConfig

getFile(String) - Method in class org.sapia.resource.FileResourceHandler

getInputStream() - Method in class org.sapia.resource.FileResource

getInputStream() - Method in interface org.sapia.resource.Resource

getInputStream() - Method in class org.sapia.resource.StringResource

getInputStream() - Method in class org.sapia.resource.UrlResource

getParent() - Method in class org.sapia.resource.include.IncludeContext

getRelative(String) - Method in class org.sapia.resource.FileResource

getRelative(String) - Method in class org.sapia.resource.include.IncludeContext

This method attempts returning a Resource that is relative to this instance's Resource.

getRelative(String) - Method in interface org.sapia.resource.Resource

getRelative(String) - Method in class org.sapia.resource.StringResource

This method throws an UnsupportedOperationException.

getRelative(String) - Method in class org.sapia.resource.UrlResource

getRelativePath(String, String, boolean) - Static method in class org.sapia.resource.Utils

Returns the path corresponding to the given base path, and the given relative path - results in "concatenation" of both, sort of.

getResource(String) - Method in class org.sapia.resource.ClasspathResourceHandler

getResource(String) - Method in class org.sapia.resource.FileResourceHandler

getResource() - Method in class org.sapia.resource.include.IncludeContext

getResource(String) - Method in interface org.sapia.resource.ResourceHandler

Returns the stream corresponding to the given URI.

getResource(String) - Method in class org.sapia.resource.UrlResourceHandler

getResourceObject(String) - Method in class org.sapia.resource.ClasspathResourceHandler

getResourceObject(String) - Method in class org.sapia.resource.FileResourceHandler

getResourceObject(String) - Method in interface org.sapia.resource.ResourceHandler

Returns the resource object corresponding to the given URI.

getResourceObject(String) - Method in class org.sapia.resource.UrlResourceHandler

getResources() - Method in class org.sapia.resource.include.IncludeConfig

getScheme(String) - Static method in class org.sapia.resource.Utils

Returns the scheme of the given URL path.

getURI() - Method in class org.sapia.resource.FileResource

getUri() - Method in class org.sapia.resource.include.IncludeContext

getURI() - Method in interface org.sapia.resource.Resource

getURI() - Method in class org.sapia.resource.StringResource

getURI() - Method in class org.sapia.resource.UrlResource

getURL() - Method in class org.sapia.resource.FileResource

getURL() - Method in interface org.sapia.resource.URLCapable

getURL() - Method in class org.sapia.resource.UrlResource

H

hasScheme(String) - Static method in class org.sapia.resource.Utils

Tests if the given path has a protocol/scheme.

I

include() - Method in class org.sapia.resource.include.IncludeContext

This method resolves the stream corresponding to this instance's URI and internally calls the doInclude(InputStream, Object) method of this instance, passing it the stream that was resolved - the called method is expected to return an object corresponding to the given stream.

include(Object) - Method in class org.sapia.resource.include.IncludeContext

This method takes an arbitrary, application-specific context object.

IncludeConfig - Class in org.sapia.resource.include

An instance of this class encapsulates application specific objects necessary to perform resource-inclusion operations.

IncludeContext - Class in org.sapia.resource.include

An instance of this class encapsulates state pertaining to a single resource-include.

IncludeContext() - Constructor for class org.sapia.resource.include.IncludeContext

IncludeContextFactory - Interface in org.sapia.resource.include

Models a factory of IncludeContexts.

includeResource() - Method in class org.sapia.resource.include.IncludeContext

This method this instance from the include stack prior to returning the included resource.

IncludeState - Class in org.sapia.resource.include

This class is used to perform file-includes programmatically.

includeStream() - Method in class org.sapia.resource.include.IncludeContext

This method this instance from the include stack prior to returning the included stream.

isAbsolute(String) - Static method in class org.sapia.resource.Utils

isWindowsDrive(String) - Static method in class org.sapia.resource.Utils

isWindowsFileSep() - Static method in class org.sapia.resource.Utils

L

lastModified() - Method in class org.sapia.resource.FileResource

lastModified() - Method in interface org.sapia.resource.Resource

lastModified() - Method in class org.sapia.resource.StringResource

lastModified() - Method in class org.sapia.resource.UrlResource

O

org.sapia.resource - package org.sapia.resource

org.sapia.resource.include - package org.sapia.resource.include

org.sapia.resource.test - package org.sapia.resource.test

P

prepend(ResourceHandler) - Method in class org.sapia.resource.ResourceHandlerChain

Adds a resource handler to the beginning of the list that this instance holds.

R

replaceWinFileSep(String) - Static method in class org.sapia.resource.Utils

resolveResource(String) - Method in interface org.sapia.resource.ResourceCapable

resolveResource(String) - Method in class org.sapia.resource.ResourceHandlerChain

Resource - Interface in org.sapia.resource

Abstracts a file resource.

ResourceCapable - Interface in org.sapia.resource

Specifies the behavior of classes that can resolve resources.

ResourceHandler - Interface in org.sapia.resource

Specifies the behavior of classes used to resolve resources.

ResourceHandlerChain - Class in org.sapia.resource

This class implements a chain of responsibility: an instance of this class holds a list of ResourceHandler instances.

ResourceHandlerChain() - Constructor for class org.sapia.resource.ResourceHandlerChain

ResourceNotFoundException - Exception in org.sapia.resource

Thrown when a resource could not be found.

ResourceNotFoundException(String) - Constructor for exception org.sapia.resource.ResourceNotFoundException

Creates a new instance of ResourceNotFoundException

S

SCHEME_FILE - Static variable in interface org.sapia.resource.Schemes

SCHEME_FTP - Static variable in interface org.sapia.resource.Schemes

SCHEME_HTTP - Static variable in interface org.sapia.resource.Schemes

SCHEME_RESOURCE - Static variable in interface org.sapia.resource.Schemes

Schemes - Interface in org.sapia.resource

select(String) - Method in class org.sapia.resource.ResourceHandlerChain

Selects a ResourceHandler from this instance and returns it.

setBasedir(String) - Method in class org.sapia.resource.FileResourceHandler

Sets the directory from which relative paths should be evaluated.

setFallBackToClasspath(boolean) - Method in class org.sapia.resource.FileResourceHandler

split(String, char, boolean) - Static method in class org.sapia.resource.Utils

Splits the given string into parts delimited by the given "split" character.

StringResource - Class in org.sapia.resource

Implements the Resource interface over a string.

StringResource(String, String) - Constructor for class org.sapia.resource.StringResource

T

TestIncludeContext - Class in org.sapia.resource.test

TestIncludeContext() - Constructor for class org.sapia.resource.test.TestIncludeContext

TestIncludedObject - Class in org.sapia.resource.test

TestIncludedObject() - Constructor for class org.sapia.resource.test.TestIncludedObject

textStreamToString(InputStream) - Static method in class org.sapia.resource.Utils

Returns the data of the given text stream as a string.

toString() - Method in class org.sapia.resource.FileResource

toString() - Method in class org.sapia.resource.include.IncludeContext

toString() - Method in class org.sapia.resource.UrlResource

toURIObject(String) - Static method in class org.sapia.resource.Utils

U

uri - Variable in class org.sapia.resource.test.TestIncludedObject

URLCapable - Interface in org.sapia.resource

This interface is implemented by Resource instances that are "capable" of returning a URL corresponding to their underlying resource.

UrlResource - Class in org.sapia.resource

Implements a Resource over a URL

UrlResource(URL) - Constructor for class org.sapia.resource.UrlResource

UrlResourceHandler - Class in org.sapia.resource

Implements a ResourceHandler that produces UrlResource instances.

UrlResourceHandler() - Constructor for class org.sapia.resource.UrlResourceHandler

Utils - Class in org.sapia.resource

This class holds various utility methods.

Utils() - Constructor for class org.sapia.resource.Utils

A C D F G H I L O P R S T U