Package rife.resources

Class DirectoryResources

java.lang.Object

rife.resources.AbstractResourceFinder

rife.resources.ResourceFinderDirectories

rife.resources.DirectoryResources

All Implemented Interfaces:

ResourceFinder, ResourceWriter

public class DirectoryResources
extends ResourceFinderDirectories
implements ResourceWriter

This class offers ResourceFinder and ResourceWriter capabilities for resources that are stored as files in a directory on the file system.

Resource names are relative paths inside the directory, where a / separator maps to a sub-directory. The directory is created when it doesn't exist yet and the content is stored as UTF-8.

Since:

1.10

See Also:

• ResourceFinder
• ResourceWriter

Constructor Summary

Constructors

Constructor	Description
DirectoryResources(File directory)	Creates a new instance for the provided directory.

Method Summary

Modifier and Type	Method	Description
void	addResource(String name, String content)	Adds a resource with the provided name and content.
boolean	removeResource(String name)	Removes the resource with the provided name.
boolean	updateResource(String name, String content)	Updates the content of the resource with the provided name.

Methods inherited from class rife.resources.ResourceFinderDirectories

getContent, getModificationTime, getResource, useStream

Methods inherited from class rife.resources.AbstractResourceFinder

getContent, getContent, getContent, getModificationTime, useStream

Methods inherited from class java.lang.Object

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

Constructor Details

DirectoryResources

public DirectoryResources(File directory)

Creates a new instance for the provided directory.

The directory will be created when it doesn't exist yet.

Parameters:

directory - the directory that the resources are stored in

Since:

1.10

Method Details

addResource

public void addResource(String name,
 String content)
                 throws ResourceWriterErrorException

Description copied from interface: ResourceWriter

Adds a resource with the provided name and content.

Specified by:

addResource in interface ResourceWriter

Parameters:

name - the name of the resource

content - the content of the resource

Throws:

ResourceWriterErrorException - if an error occurred during the resource addition.

updateResource

public boolean updateResource(String name,
 String content)
                       throws ResourceWriterErrorException

Description copied from interface: ResourceWriter

Updates the content of the resource with the provided name.

Specified by:

updateResource in interface ResourceWriter

Parameters:

name - the name of the resource

content - the content of the resource

Returns:

true when the resource was updated; false otherwise

Throws:

ResourceWriterErrorException - if an error occurred during the resource update.

removeResource

public boolean removeResource(String name)
                       throws ResourceWriterErrorException

Description copied from interface: ResourceWriter

Removes the resource with the provided name.

Specified by:

removeResource in interface ResourceWriter

Parameters:

name - the name of the resource

Returns:

true when the resource was removed; false otherwise

Throws:

ResourceWriterErrorException - if an error occurred during the resource removal.