info.magnolia.resourceloader

Class AbstractResource

java.lang.Object

info.magnolia.resourceloader.AbstractResource

All Implemented Interfaces:

Resource

Direct Known Subclasses:

ClasspathResource, FileSystemResource, JcrResource, LayeredResource

public abstract class AbstractResource
extends Object
implements Resource

A convenient class to extend by subclasses of AbstractResourceOrigin. Subclasses merely need to expose a constructor for the ResourceOrigin to use, and a method to let it retrieve the underlying resource object.

See Also:

AbstractResourceOrigin

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractResource(AbstractResourceOrigin origin)

Method Summary

Methods

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.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractResource

protected AbstractResource(AbstractResourceOrigin origin)

Method Detail

getOrigin

public ResourceOrigin getOrigin()

Specified by:

getOrigin in interface Resource

isFile

public boolean isFile()

Specified by:

isFile in interface Resource

isDirectory

public boolean isDirectory()

Specified by:

isDirectory in interface Resource

isEditable

public boolean isEditable()

Description copied from interface: Resource

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

Specified by:

isEditable in interface Resource

getPath

public String getPath()

Description copied from interface: Resource

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.

Specified by:

getPath in interface Resource

getName

public String getName()

Specified by:

getName in interface Resource

getLastModified

public long getLastModified()

Description copied from interface: Resource

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

Specified by:

getLastModified in interface Resource

See Also:

Date.getTime()

listChildren

public List<Resource> listChildren()

Specified by:

listChildren in interface Resource

getParent

public Resource getParent()

Specified by:

getParent in interface Resource

openStream

public InputStream openStream()
                       throws IOException

Description copied from interface: Resource

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

Specified by:

openStream in interface Resource

Throws:

IOException

See Also:

Resource.openReader()

openReader

public Reader openReader()
                  throws IOException

Description copied from interface: Resource

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.

Specified by:

openReader in interface Resource

Throws:

IOException

See Also:

Resource.openStream()

toString

public String toString()

Overrides:

toString in class Object