de.smartics.properties.resource.filesystem.heap
Class FileSystemResourceHeap

java.lang.Object
  de.smartics.properties.resource.filesystem.heap.FileSystemResourceHeap

All Implemented Interfaces:

ResourceHeap

public final class FileSystemResourceHeap
     
     

      
      extends 
      
      Object
     
     
     
     

      
      implements 
      
      ResourceHeap
     
     

Provides an implementation of ResourceHeap based on a file system.

Constructor Summary

FileSystemResourceHeap()

Method Summary

void	addRootFolder(File rootFolder) Adds a root folder to check for property resources.
ArtifactId	getDefaultArtifactId() Returns the artifact identifier to use for properties files encountered.
ClassPathEnvironment	resolve() Resolves the properties resources from this heap.
void	setDefaultArtifactId(ArtifactId defaultArtifactId) Sets the artifact identifier to use for properties files encountered.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileSystemResourceHeap

public FileSystemResourceHeap()

Method Detail

getDefaultArtifactId

public ArtifactId getDefaultArtifactId()

Returns the artifact identifier to use for properties files encountered.

Returns:

the artifact identifier to use for properties files encountered.

setDefaultArtifactId

public void setDefaultArtifactId(ArtifactId defaultArtifactId)

Sets the artifact identifier to use for properties files encountered.

Parameters:

defaultArtifactId - the artifact identifier to use for properties files encountered.

addRootFolder

public void addRootFolder(File rootFolder)
                   throws NullPointerException,
                          IllegalArgumentException

Adds a root folder to check for property resources.

Parameters:

rootFolder - the folder to add as a root to check for property resources.

Throws:

NullPointerException - if rootFolder is null.

IllegalArgumentException - if rootFolder is not a directory.

resolve

public ClassPathEnvironment resolve()
                             throws HeapException

Description copied from interface: ResourceHeap

Resolves the properties resources from this heap.

Specified by:

resolve in interface ResourceHeap

Returns:

the properties resources.

Throws:

HeapException - on any problem accessing the heap.