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

Package class diagram package FileSystemResourceHeap
java.lang.Object
  extended by de.smartics.properties.resource.filesystem.heap.FileSystemResourceHeap
All Implemented Interfaces:
de.smartics.properties.resource.heap.ResourceHeap

public final class FileSystemResourceHeap
     
     
extends Object
implements de.smartics.properties.resource.heap.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.
 de.smartics.properties.resource.domain.ArtifactId getDefaultArtifactId()
          Returns the artifact identifier to use for properties files encountered.
 de.smartics.properties.resource.domain.ClassPathEnvironment resolve()
           
 void setDefaultArtifactId(de.smartics.properties.resource.domain.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 de.smartics.properties.resource.domain.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(de.smartics.properties.resource.domain.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 de.smartics.properties.resource.domain.ClassPathEnvironment resolve()
                                                                    throws de.smartics.properties.resource.heap.HeapException
Specified by:
resolve in interface de.smartics.properties.resource.heap.ResourceHeap
Throws:
de.smartics.properties.resource.heap.HeapException


Copyright © 2013 Kronseder & Reiner GmbH - smartics. All Rights Reserved.