info.magnolia.resourceloader

Interface Resource

All Known Implementing Classes:

AbstractResource, ClasspathResource, FileSystemResource, JcrResource, LayeredResource, ResourceStub

public interface Resource

The Resource is a common specific type for dealing with resources uniformly across arbitrary ResourceOrigins. Note that ResourceOrigin doesn't guarantee to always return the same Resource instance for an arbitrary path, therefore implementors are responsible for providing meaningful equals and hashCode methods here.

Method Summary

Modifier and Type	Method and Description
long	getLastModified() Returns the last modification date of this resource as the number of milliseconds since January 1, 1970, 00:00:00 GMT.
String	getName()
ResourceOrigin	getOrigin()
Resource	getParent()
String	getPath() Returns the "absolute" path to this resource.
boolean	isDirectory()
boolean	isEditable() Determines whether this resource can be edited in its underlying origin.
boolean	isFile()
List<Resource>	listChildren()
Reader	openReader() Opens a Reader for this resource; if the associated ResourceOrigin can guess it, this will have been opened with the corrected encoding.
InputStream	openStream() Opens an InputStream for this resource.

Method Detail

getOrigin

ResourceOrigin getOrigin()

isFile

boolean isFile()

isDirectory

boolean isDirectory()

isEditable

boolean isEditable()

Determines whether this resource can be edited in its underlying origin.

getPath

String getPath()

Returns the "absolute" path to this resource. Depending on the implementation, it might in effect be relative to some other root path, but the user of this package should consider them absolute.

getName

String getName()

getLastModified

long getLastModified()

Returns the last modification date of this resource as the number of milliseconds since January 1, 1970, 00:00:00 GMT.

See Also:

Date.getTime()

getParent

Resource getParent()

listChildren

List<Resource> listChildren()

openStream

InputStream openStream()
                throws IOException

Opens an InputStream for this resource. Client code is expected to close the stream.

Throws:

IOException

See Also:

openReader()

openReader

Reader openReader()
           throws IOException

Opens a Reader for this resource; if the associated ResourceOrigin can guess it, this will have been opened with the corrected encoding. Client code is expected to close the reader.

Throws:

IOException

See Also:

openStream()