uPortal 2.4.1
API Documentation

org.jasig.portal
Class PropertiesManager

java.lang.Object
  extended byorg.jasig.portal.PropertiesManager

Deprecated. since uPortal 2.4, this class has moved to org.jasig.portal.properties

public class PropertiesManager
extends java.lang.Object

Deprecated PropertiesManager. This class still exists here at org.jasig.portal.PropertiesManager in order to delegate all requests to the real PropertiesManager at org.jasig.portal.properties.PropertiesManager so as not to break backwards compatibility. Pre 2.4 code which imports this old PropertiesManager should still work great. However, note that there is new functionality to be had from the new PropertiesManager in the form of reporting of missing properties and methods which take default values. Please change your imports to import the new PropertiesManager. Presumably this deprecated class will disappear in a future uPortal release.

Since:
uPortal 2.0
Version:
$Revision: 1.15 $ $Date: 2004/09/22 19:49:41 $
Author:
andrew.petro@yale.edu - deprecated and moved. see org.jasig.portal.properties.PropertiesManager

Constructor Summary
PropertiesManager()
          Deprecated.  
 
Method Summary
static java.lang.String getProperty(java.lang.String name)
          Deprecated. Returns the value of a property for a given name.
static boolean getPropertyAsBoolean(java.lang.String name)
          Deprecated. Returns the value of a property for a given name.
static byte getPropertyAsByte(java.lang.String name)
          Deprecated. Returns the value of a property for a given name as a byte
static double getPropertyAsDouble(java.lang.String name)
          Deprecated. Returns the value of a property for a given name as a long
static float getPropertyAsFloat(java.lang.String name)
          Deprecated. Returns the value of a property for a given name as a float
static int getPropertyAsInt(java.lang.String name)
          Deprecated. Returns the value of a property for a given name as an int
static long getPropertyAsLong(java.lang.String name)
          Deprecated. Returns the value of a property for a given name as a long
static short getPropertyAsShort(java.lang.String name)
          Deprecated. Returns the value of a property for a given name as a short
static java.lang.String getPropertyUntrimmed(java.lang.String name)
          Deprecated. Returns the value of a property for a given name including whitespace trailing the property value, but not including whitespace leading the property value.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PropertiesManager

public PropertiesManager()
Deprecated. 
Method Detail

getProperty

public static java.lang.String getProperty(java.lang.String name)
                                    throws MissingPropertyException
Deprecated. 
Returns the value of a property for a given name.

Parameters:
name - the name of the requested property
Returns:
value the value of the property matching the requested name
Throws:
MissingPropertyException - - if the requested property cannot be found

getPropertyUntrimmed

public static java.lang.String getPropertyUntrimmed(java.lang.String name)
                                             throws MissingPropertyException
Deprecated. 
Returns the value of a property for a given name including whitespace trailing the property value, but not including whitespace leading the property value.

Parameters:
name - the name of the requested property
Returns:
value the value of the property matching the requested name
Throws:
MissingPropertyException - - (undeclared) if the requested property is not found

getPropertyAsBoolean

public static boolean getPropertyAsBoolean(java.lang.String name)
                                    throws MissingPropertyException
Deprecated. 
Returns the value of a property for a given name. This method can be used if the property is boolean in nature and you want to make sure that true is returned if the property is set to "true", "yes", "y", or "on" (regardless of case), and false is returned in all other cases.

Parameters:
name - the name of the requested property
Returns:
value true if property is set to "true", "yes", "y", or "on" regardless of case, otherwise false
Throws:
MissingPropertyException - - when no property of the given name is declared.

getPropertyAsByte

public static byte getPropertyAsByte(java.lang.String name)
                              throws MissingPropertyException,
                                     BadPropertyException
Deprecated. 
Returns the value of a property for a given name as a byte

Parameters:
name - the name of the requested property
Returns:
value the property's value as a byte
Throws:
MissingPropertyException - - if the property is not set
BadPropertyException - - if the property cannot be parsed as a byte

getPropertyAsShort

public static short getPropertyAsShort(java.lang.String name)
                                throws MissingPropertyException,
                                       BadPropertyException
Deprecated. 
Returns the value of a property for a given name as a short

Parameters:
name - the name of the requested property
Returns:
value the property's value as a short
Throws:
MissingPropertyException - - if the property is not set
BadPropertyException - - if the property cannot be parsed as a short or is not set.

getPropertyAsInt

public static int getPropertyAsInt(java.lang.String name)
                            throws MissingPropertyException,
                                   BadPropertyException
Deprecated. 
Returns the value of a property for a given name as an int

Parameters:
name - the name of the requested property
Returns:
value the property's value as an int
Throws:
MissingPropertyException - - if the property is not set
BadPropertyException - - if the property cannot be parsed as an int

getPropertyAsLong

public static long getPropertyAsLong(java.lang.String name)
                              throws MissingPropertyException,
                                     BadPropertyException
Deprecated. 
Returns the value of a property for a given name as a long

Parameters:
name - the name of the requested property
Returns:
value the property's value as a long
Throws:
MissingPropertyException - - if the property is not set
BadPropertyException - - if the property cannot be parsed as a long

getPropertyAsFloat

public static float getPropertyAsFloat(java.lang.String name)
                                throws MissingPropertyException,
                                       BadPropertyException
Deprecated. 
Returns the value of a property for a given name as a float

Parameters:
name - the name of the requested property
Returns:
value the property's value as a float
Throws:
MissingPropertyException - - if the property is not set
BadPropertyException - - if the property cannot be parsed as a float

getPropertyAsDouble

public static double getPropertyAsDouble(java.lang.String name)
                                  throws MissingPropertyException,
                                         BadPropertyException
Deprecated. 
Returns the value of a property for a given name as a long

Parameters:
name - the name of the requested property
Returns:
value the property's value as a double
Throws:
MissingPropertyException - - if the property has not been set
BadPropertyException - - if the property cannot be parsed as a double or is not set.

uPortal 2.4.1
API Documentation