|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.crosswire.jsword.util.Project
public final class Project
The Project class looks after the source of project files.
These are per user files and as such have a different location
on different operating systems. These are:
Mac OS X | ~/Library/Application Support/JSword |
Win NT/2000/XP/ME/9x | ~/Application Data/JSword (~ is all over the place, but Java figures it out) |
Unix and otherwise | ~/.jsword |
Previously the location was ~/.jsword, which is unfriendly in the Windows and Mac world. If this location is found on Mac or Windows, it will be moved to the new location, if different and possible.
Note: If the Java System property jsword.home is set and it exists and is writeable then it will be used instead of the above location. This is useful for USB Drives and other portable implementations of JSword. I is recommended that this name be JSword.
for license details.
The copyright to this program is held by it's authors.
Field Summary | |
---|---|
static String |
DIR_NETCACHE
The cache of downloaded files inside the project directory |
static String |
DIR_PROJECT
The JSword user settings directory |
static String |
DIR_PROJECT_ALT
The JSword user settings directory for Mac and Windows |
private URI |
home
The home for this application |
private static Project |
instance
The filesystem resources |
private static Logger |
log
The log stream |
private static String |
PROPERTY_JSWORD_HOME
System property for jsword home directory |
Constructor Summary | |
---|---|
private |
Project()
Prevent Instansiation. |
Method Summary | |
---|---|
URI |
getDeprecatedUserProjectDir()
Get the location where the project dir used to be. |
URI |
getTempScratchSpace(String subject,
boolean create)
When we need a directory to write stuff to. |
URI |
getUserProjectDir()
Establishes the user's project directory. |
URI |
getUserProjectDir(String hiddenFolderName,
String visibleFolderName)
Establishes the user's project directory. |
URI |
getWritablePropertiesURI(String subject)
Get a the URI of a (potentially non-existant) properties file that we can write to. |
static Project |
instance()
Accessor for the resource singleton. |
private URI |
migrateUserProjectDir(URI oldPath,
URI newPath)
Migrates the user's project dir, if necessary and possible. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String DIR_NETCACHE
public static final String DIR_PROJECT
public static final String DIR_PROJECT_ALT
private static final String PROPERTY_JSWORD_HOME
private URI home
private static final Logger log
private static Project instance
Constructor Detail |
---|
private Project()
The biggest job is trying to work out which resource bundle to load to work out where the config and data files are stored. We construct a name from the projectname, hostname and any other info and then try to use that.
Method Detail |
---|
public static Project instance()
public URI getUserProjectDir(String hiddenFolderName, String visibleFolderName)
public URI getUserProjectDir()
public URI getDeprecatedUserProjectDir()
private URI migrateUserProjectDir(URI oldPath, URI newPath)
oldPath
- the path to the old, deprecated locationnewPath
- the path to the new location
public URI getWritablePropertiesURI(String subject)
subject
- The name (minus the .properties extension)
public URI getTempScratchSpace(String subject, boolean create) throws IOException
This directory should be used as a cache for something that could also be got at runtime by some other means.
So it is not for config data, and not for program files. If someone were to delete all the files in this directory while you weren't looking then life should not stop, but should carry on albeit with a slower service.
This method may well return null if we are running in a restricted environment, so callers of this method should be prepared for that eventuallity too.
As a result of these limitations it could be OK to use File
in
place of URI
(which is the norm for this project), however there
doesn't seem to be a good reason to relax this rule here.
subject
- A moniker for the area to write to. This will be converted into a directory name.
IOException
|
Copyright ยจ 2003-2007 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |