org.openmobileis.common.util.PropertiesService Interface Reference

Inheritance diagram for org.openmobileis.common.util.PropertiesService:

org.openmobileis.common.util.PropertiesManager

List of all members.


Detailed Description

Author:
phil

Definition at line 12 of file PropertiesService.java.


Public Member Functions

String getProperty (String key, String defaultValue)
 return the property with specified key from loaded properties.
String getProperty (String key)
 return the property with specified key from loaded properties.
void addProperty (String key, String value)
 add the specified key,value to the manager properties
void removeAllProperties ()
 remove all resource manager properties
void addPropertiesFile (String filename) throws IOException
 load a property file inside the classpath.
void addPropertiesFileFromFilePath (String filename) throws java.io.IOException
 load a property file from the file system If not found throw IOException
java.util.Properties getProperties (String prop_file) throws java.io.IOException
 read the property file inside the classpath.
java.util.Properties getPropertiesFromPath (String prop_file) throws java.io.IOException
 read the property file from the file system Does not load it
java.util.Properties getProperties ()
 return all the loaded properties

Member Function Documentation

String org.openmobileis.common.util.PropertiesService.getProperty ( String  key,
String  defaultValue 
)

return the property with specified key from loaded properties.

return default value if not found.

Parameters:
key : the property key to get
defaultValue : default value if key is not found
Returns:
the property with specified key or default value if not found.

Implemented in org.openmobileis.common.util.PropertiesManager.

String org.openmobileis.common.util.PropertiesService.getProperty ( String  key  ) 

return the property with specified key from loaded properties.

return null if not found.

Parameters:
key : the property key to get
Returns:
the property with specified key or null if not found.

Implemented in org.openmobileis.common.util.PropertiesManager.

void org.openmobileis.common.util.PropertiesService.addProperty ( String  key,
String  value 
)

add the specified key,value to the manager properties

Parameters:
key : the property key
value : value of the property

Implemented in org.openmobileis.common.util.PropertiesManager.

void org.openmobileis.common.util.PropertiesService.addPropertiesFile ( String  filename  )  throws IOException

load a property file inside the classpath.

if the path is /org/openmobileis/file.properties First look in the classpath for /properties/org/openmobileis/file.properties then in /org/openmobileis/file.properties. If not found throw IOException

Parameters:
filename : properties file name.
Exceptions:
IOException : throws if the file is not found

Implemented in org.openmobileis.common.util.PropertiesManager.

void org.openmobileis.common.util.PropertiesService.addPropertiesFileFromFilePath ( String  filename  )  throws java.io.IOException

load a property file from the file system If not found throw IOException

Parameters:
filename : properties file name.
Exceptions:
IOException : throws if the file is not found

Implemented in org.openmobileis.common.util.PropertiesManager.

java.util.Properties org.openmobileis.common.util.PropertiesService.getProperties ( String  prop_file  )  throws java.io.IOException

read the property file inside the classpath.

Does not load it if the path is /org/openmobileis/file.properties First looks in the classpath for /properties/org/openmobileis/file.properties then for /org/openmobileis/file.properties. If not found throw IOException

Parameters:
filename : properties file name.
Exceptions:
IOException : throws if the file is not found

Implemented in org.openmobileis.common.util.PropertiesManager.

java.util.Properties org.openmobileis.common.util.PropertiesService.getPropertiesFromPath ( String  prop_file  )  throws java.io.IOException

read the property file from the file system Does not load it

Parameters:
filename : properties file name.
Exceptions:
IOException : throws if the file is not found

Implemented in org.openmobileis.common.util.PropertiesManager.

java.util.Properties org.openmobileis.common.util.PropertiesService.getProperties (  ) 

return all the loaded properties

Returns:
the loaded properties

Implemented in org.openmobileis.common.util.PropertiesManager.


The documentation for this interface was generated from the following file:
Generated on Mon Jan 14 17:29:52 2008 for OpenMobileIS by  doxygen 1.5.4