org.kocakosm.pitaya.io

Class Resource

java.lang.Object

org.kocakosm.pitaya.io.Resource

public final class Resource
extends Object

A classpath resource.

Author:

Osman KOCAK

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Resource.NotFoundException Thrown to indicate that a resource can't be found.

Method Summary

Methods

Modifier and Type	Method and Description
void	copyTo(OutputStream out) Copies the content of this resource to the specified stream.
void	copyTo(Writer out, Charset charset) Copies the content of this resource to the specified stream.
boolean	equals(Object o)
static Resource	find(String name) Finds and returns the resource having the given name using the context class loader.
static Resource	find(String name, Class<?> contextClass) Finds and returns the resource having the given name (relative to the specified class).
URL	getURL() Returns this resource's URL.
int	hashCode()
byte[]	read() Reads and returns this resource's content as a byte[].
String	read(Charset charset) Reads and returns this resource's content as a String.
List<String>	readLines(Charset charset) Reads and returns all this resource's lines.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

find

public static Resource find(String name)

Finds and returns the resource having the given name using the context class loader. Note that if the context class loader is null, the class loader that loaded this class will be used instead.

Parameters:

name - the resource's name.

Returns:

the requested resource.

Throws:

NullPointerException - if name is null.

Resource.NotFoundException - if the resource can't be found.

find

public static Resource find(String name,
            Class<?> contextClass)

Finds and returns the resource having the given name (relative to the specified class).

Parameters:

name - the resource's name.

contextClass - the context class.

Returns:

the requested resource.

Throws:

NullPointerException - if name is null.

Resource.NotFoundException - if the resource can't be found.

getURL

public URL getURL()

Returns this resource's URL.

Returns:

this resource's URL.

copyTo

public void copyTo(OutputStream out)
            throws IOException

Copies the content of this resource to the specified stream.

Parameters:

out - the stream to copy to.

Throws:

NullPointerException - if out is null.

IOException - if an I/O error occurs during the process.

copyTo

public void copyTo(Writer out,
          Charset charset)
            throws IOException

Copies the content of this resource to the specified stream.

Parameters:

out - the stream to copy to.

charset - the charset to use.

Throws:

NullPointerException - if one of the arguments is null.

IOException - if an I/O error occurs during the process.

read

public byte[] read()
            throws IOException

Reads and returns this resource's content as a byte[].

Returns:

this resource's content.

Throws:

IOException - if an I/O error occurs during the process.

read

public String read(Charset charset)
            throws IOException

Reads and returns this resource's content as a String.

Parameters:

charset - the charset to use.

Returns:

this resource's content.

Throws:

NullPointerException - if charset is null.

IOException - if an I/O error occurs during the process.

readLines

public List<String> readLines(Charset charset)
                       throws IOException

Reads and returns all this resource's lines. Note that the returned List is immutable.

Parameters:

charset - the charset to use.

Returns:

this resource's lines.

Throws:

NullPointerException - if charset is null.

IOException - if an I/O error occurs during the process.

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object