org.pz.platypus.utilities
Class PlatypusHomeDirectory

java.lang.Object
  extended by org.pz.platypus.utilities.PlatypusHomeDirectory

public class PlatypusHomeDirectory
extends java.lang.Object

Gets the home directory for Platypus as set in the user environment.

Author:
alb

Field Summary
private  java.lang.String homeDirectory
           
 
Constructor Summary
PlatypusHomeDirectory(java.lang.Class gddClass)
          Creates a string of the home directory from the user environment and makes sure it ends with a file separator.
 
Method Summary
 java.lang.String get()
          return the home directory name with a file separator at end
(package private)  java.lang.String getHomeDirectoryFromTextFile()
          Looks to see if the current directory holds a file called 'platypus.home'.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

homeDirectory

private java.lang.String homeDirectory
Constructor Detail

PlatypusHomeDirectory

public PlatypusHomeDirectory(java.lang.Class gddClass)
Creates a string of the home directory from the user environment and makes sure it ends with a file separator. In the event, the home directory is not specified, PlatypusHomeDirectory.get() returns null.

Parameters:
gddClass - used in the commented-out code
Method Detail

getHomeDirectoryFromTextFile

java.lang.String getHomeDirectoryFromTextFile()
Looks to see if the current directory holds a file called 'platypus.home'. If it does, and there is a subdirectory called 'config' than the current directory is deemed the home directory.

Returns:
home directory for Platypus

get

public java.lang.String get()
return the home directory name with a file separator at end

Returns:
the directory name


Copyright © 2008-10 Pacific Data Works LLC