com.ptc.windchill.esi.utl
Class ESIProperties

java.lang.Object
  extended by com.ptc.windchill.esi.utl.ESIProperties

public final class ESIProperties
extends Object

Assists ESI classes in obtaining ESI configuration information.

Supported API: true

Extendable: false


Method Summary
static Class getClass(ESIPropertyRequest req)
          Given an ESIPropertyRequest, return the java class that is identified by that property.
static String getProperty(ESIPropertyRequest request)
          Returns the ESI property whose key equals the request.getName().
static String getProperty(String name)
          Returns the ESI property whose key equals the name argument.
static boolean getProperty(String name, boolean dflt)
          Convenience method to get a boolean property string and convert it to a boolean value.
static String getProperty(String name, String defaultValue)
          Returns the ESI property whose key equals the name argument.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getProperty

public static String getProperty(String name)
Returns the ESI property whose key equals the name argument.

Supported API: true

Parameters:
name -
Returns:
String

getProperty

public static String getProperty(String name,
                                 String defaultValue)
Returns the ESI property whose key equals the name argument. If no property is found, the defaultValue argument is returned.

Supported API: true

Parameters:
name -
defaultValue -
Returns:
String

getProperty

public static String getProperty(ESIPropertyRequest request)
Returns the ESI property whose key equals the request.getName(). If no property is found, request.getDefaultValue() is returned.

Supported API: true

Parameters:
request -
Returns:
String

getClass

public static Class getClass(ESIPropertyRequest req)
Given an ESIPropertyRequest, return the java class that is identified by that property. If an exception occurs, log it and return null.

Supported API: true

Parameters:
req -
Returns:
Class

getProperty

public static boolean getProperty(String name,
                                  boolean dflt)
Convenience method to get a boolean property string and convert it to a boolean value.

Supported API: true

Parameters:
name - the property name.
default - value returned if named property does not exist
Returns:
the value as a boolean.