org.ringojs.repository

Interface Resource

All Superinterfaces:

Serializable, Trackable

All Known Implementing Classes:

AbstractResource, FileResource, StringResource, WebappResource, ZipResource

public interface Resource
extends Trackable

Resource represents a pointer to some kind of information (code, skin, ...) from which the content can be fetched

Method Summary

Modifier and Type	Method and Description
String	getBaseName() Returns the short name of the resource with the file extension (everything following the last dot character) cut off.
String	getContent() Returns the content of the resource
String	getContent(String encoding) Returns the content of the resource in a given encoding
InputStream	getInputStream() Returns an input stream to the content of the resource
long	getLength() Returns the length of the resource's content
int	getLineNumber() Return the current line number of this resource.
Reader	getReader() Returns a reader for the resource
Reader	getReader(String encoding) Returns a reader for the resource using the given character encoding
String	getRelativePath() Get the path of this resource relative to its root repository.
boolean	getStripShebang() Returns true if the input stream for this resource will look for a first line starting with the characters #! and suppress it if found
void	setStripShebang(boolean stripShebang) Switch shebang stripping on or off

Methods inherited from interface org.ringojs.repository.Trackable

exists, getChecksum, getModuleName, getName, getParentRepository, getPath, getRootRepository, getUrl, isAbsolute, lastModified, setAbsolute

Method Detail

getLength

long getLength()

Returns the length of the resource's content

Returns:

content length

getInputStream

InputStream getInputStream()
                    throws IOException

Returns an input stream to the content of the resource

Returns:

content input stream

Throws:

IOException - if a I/O related error occurs

getReader

Reader getReader(String encoding)
          throws IOException

Returns a reader for the resource using the given character encoding

Parameters:

encoding - the character encoding

Returns:

the reader

Throws:

IOException - if a I/O related error occurs

getReader

Reader getReader()
          throws IOException

Returns a reader for the resource

Returns:

the reader

Throws:

IOException - if a I/O related error occurs

getContent

String getContent(String encoding)
           throws IOException

Returns the content of the resource in a given encoding

Parameters:

encoding - the character encoding

Returns:

the content

Throws:

IOException - if a I/O related error occurs

getContent

String getContent()
           throws IOException

Returns the content of the resource

Returns:

the content

Throws:

IOException - if a I/O related error occurs

getBaseName

String getBaseName()

Returns the short name of the resource with the file extension (everything following the last dot character) cut off.

Returns:

the file name without the file extension

getRelativePath

String getRelativePath()

Get the path of this resource relative to its root repository.

Specified by:

getRelativePath in interface Trackable

Returns:

the relative resource path

getStripShebang

boolean getStripShebang()

Returns true if the input stream for this resource will look for a first line starting with the characters #! and suppress it if found

Returns:

true if shebang stripping is enabled

setStripShebang

void setStripShebang(boolean stripShebang)

Switch shebang stripping on or off

Parameters:

stripShebang - true to enable shebang stripping

getLineNumber

int getLineNumber()

Return the current line number of this resource. Useful in combination with things like shebang stripping and shell input.

Returns:

the current line number of this resource