org.glyptodon.guacamole.net.basic.resource

Class ClassPathResource

java.lang.Object

org.glyptodon.guacamole.net.basic.resource.AbstractResource

org.glyptodon.guacamole.net.basic.resource.ClassPathResource

All Implemented Interfaces:

Resource

public class ClassPathResource
extends AbstractResource

A resource which is located within the classpath of an arbitrary ClassLoader.

Author:

Michael Jumper

Constructor Summary

Constructors

Constructor and Description
ClassPathResource(ClassLoader classLoader, String mimetype, String path) Creates a new ClassPathResource which uses the given ClassLoader to read the resource having the given path.
ClassPathResource(String mimetype, String path) Creates a new ClassPathResource which uses the ClassLoader associated with the ClassPathResource class to read the resource having the given path.

Method Summary

Modifier and Type	Method and Description
InputStream	asStream() Returns an InputStream which reads the contents of this resource, starting with the first byte.

Methods inherited from class org.glyptodon.guacamole.net.basic.resource.AbstractResource

getLastModified, getMimeType

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassPathResource

public ClassPathResource(ClassLoader classLoader,
                         String mimetype,
                         String path)

Creates a new ClassPathResource which uses the given ClassLoader to read the resource having the given path.

Parameters:

classLoader - The ClassLoader to use when reading the resource.

mimetype - The mimetype of the resource.

path - The path of the resource relative to the given ClassLoader.

ClassPathResource

public ClassPathResource(String mimetype,
                         String path)

Creates a new ClassPathResource which uses the ClassLoader associated with the ClassPathResource class to read the resource having the given path.

Parameters:

mimetype - The mimetype of the resource.

path - The path of the resource relative to the ClassLoader associated with the ClassPathResource class.

Method Detail

asStream

public InputStream asStream()

Description copied from interface: Resource

Returns an InputStream which reads the contents of this resource, starting with the first byte. Reading from the returned InputStream will not affect reads from other InputStreams returned by other calls to asStream(). The returned InputStream must be manually closed when no longer needed. If the resource is unexpectedly unavailable, this will return null.

Returns:

An InputStream which reads the contents of this resource, starting with the first byte, or null if the resource is unavailable.