info.magnolia.resourceloader

Class AbstractResourceOrigin<P extends AbstractResource>

java.lang.Object

info.magnolia.resourceloader.AbstractResourceOrigin<P>

Type Parameters:

P - Subclasses of AbstractResourceOrigin are expected to produce Resource instances which are subclasses of AbstractResource.

All Implemented Interfaces:

ResourceOrigin<P>

Direct Known Subclasses:

ClasspathResourceOrigin, FileSystemResourceOrigin, JcrResourceOrigin, LayeredResourceOrigin

public abstract class AbstractResourceOrigin<P extends AbstractResource>
extends Object
implements ResourceOrigin<P>

Exposes methods that AbstractResource simply delegates to. Consequently, one only has to implement and test AbstractResourceOrigin's methods, while navigation still happens naturally through the Resource methods. AbstractResource implementations are merely vehicles for the underlying resource.

Nested Class Summary

Nested classes/interfaces inherited from interface info.magnolia.resourceloader.ResourceOrigin

ResourceOrigin.ResourceNotFoundException

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractResourceOrigin(String name)

Method Summary

Modifier and Type	Method and Description
void	dispatchResourceChange(ResourceOriginChange change)
protected abstract InputStream	doOpenStream(P resource)
protected abstract Charset	getCharsetFor(P resource) Returns the preferred Charset to read the given Resource.
protected abstract long	getLastModified(P resource)
String	getName() Returns the name of this origin.
protected abstract String	getName(P resource)
protected abstract P	getParent(P resource)
protected abstract String	getPath(P resource)
protected void	initializeResourceChangeMonitoring() Start monitoring underlying resource changes.
protected abstract boolean	isDirectory(P resource)
protected boolean	isEditable(P resource)
protected abstract boolean	isFile(P resource)
protected abstract List<P>	listChildren(P resource)
protected Reader	openReader(P resource)
protected InputStream	openStream(P resource)
ResourceChangeHandlerRegistration	registerResourceChangeHandler(ResourceChangeHandler changeHandler) Hook the underlying resource change monitoring mechanism (if any) to a provided handler.
void	traverseWith(ResourceVisitor visitor) Traverses this ResourceOrigin from the root, according to the given ResourceVisitor.
void	watchForChanges(ResourceVisitor visitor) Deprecated. since 5.4.6 - use registerResourceChangeHandler(ResourceChangeHandler) instead. See ResourceOrigin.watchForChanges(ResourceVisitor) JavaDoc for more details

Methods inherited from class java.lang.Object

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

Methods inherited from interface info.magnolia.resourceloader.ResourceOrigin

getByPath, getRoot, hasPath

Constructor Detail

AbstractResourceOrigin

protected AbstractResourceOrigin(String name)

Method Detail

getName

public String getName()

Description copied from interface: ResourceOrigin

Returns the name of this origin. This may be used to describe/differentiate origin instances, and generate i18n keys accordingly.

Specified by:

getName in interface ResourceOrigin<P extends AbstractResource>

traverseWith

public void traverseWith(ResourceVisitor visitor)

Description copied from interface: ResourceOrigin

Traverses this ResourceOrigin from the root, according to the given ResourceVisitor.

Specified by:

traverseWith in interface ResourceOrigin<P extends AbstractResource>

See Also:

ResourceVisitor, PredicatedResourceVisitor, ResourceTreeWalker

watchForChanges

@Deprecated
public void watchForChanges(ResourceVisitor visitor)

Deprecated. since 5.4.6 - use registerResourceChangeHandler(ResourceChangeHandler) instead. See ResourceOrigin.watchForChanges(ResourceVisitor) JavaDoc for more details

Description copied from interface: ResourceOrigin

Sets up observation for this origin, and hooks it to the given callback ResourceVisitor.

Specified by:

watchForChanges in interface ResourceOrigin<P extends AbstractResource>

See Also:

ResourceVisitor, PredicatedResourceVisitor

registerResourceChangeHandler

public ResourceChangeHandlerRegistration registerResourceChangeHandler(ResourceChangeHandler changeHandler)

Description copied from interface: ResourceOrigin

Hook the underlying resource change monitoring mechanism (if any) to a provided handler.

Specified by:

registerResourceChangeHandler in interface ResourceOrigin<P extends AbstractResource>

See Also:

ResourceOriginChange

dispatchResourceChange

public final void dispatchResourceChange(ResourceOriginChange change)

initializeResourceChangeMonitoring

protected void initializeResourceChangeMonitoring()

Start monitoring underlying resource changes.

isFile

protected abstract boolean isFile(P resource)

See Also:

Resource.isFile()

isDirectory

protected abstract boolean isDirectory(P resource)

See Also:

Resource.isDirectory()

isEditable

protected boolean isEditable(P resource)

See Also:

Resource.isEditable()

getPath

protected abstract String getPath(P resource)

See Also:

Resource.getPath()

getName

protected abstract String getName(P resource)

See Also:

Resource.getName()

getLastModified

protected abstract long getLastModified(P resource)

See Also:

Resource.getLastModified()

listChildren

protected abstract List<P> listChildren(P resource)

See Also:

Resource.listChildren()

getParent

protected abstract P getParent(P resource)

See Also:

Resource.getParent()

openStream

protected InputStream openStream(P resource)
                          throws IOException

Throws:

IOException

See Also:

Resource.openStream()

doOpenStream

protected abstract InputStream doOpenStream(P resource)
                                     throws IOException

Throws:

IOException

openReader

protected Reader openReader(P resource)
                     throws IOException

Throws:

IOException

See Also:

Resource.openReader()

getCharsetFor

protected abstract Charset getCharsetFor(P resource)

Returns the preferred Charset to read the given Resource.