com.ptc.windchill.esi.utl
Class ESIProperties

java.lang.Object
  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

Field Summary

private static String	CLASSNAME
static int	COLLECTION_SIZE_MULTIPLIER
private static String	COLLECTION_SIZE_MULTIPLIER_PROPERTY
static boolean	DEBUG
private static String	DEBUG_PROPERTY
private static Properties	properties
static String	PROPERTY_PREFIX
private static String	RESOURCE
static boolean	VERBOSE
private static String	VERBOSE_PROPERTY

Constructor Summary

ESIProperties()

Method Summary

static Class	getClass(ESIPropertyRequest req) Given an ESIPropertyRequest, return the java class that is identified by that property.
static String	getCodebasePath() Returns the path to the root ESI directory within the Windchill codebase directory structure.
static int	getIntProperty(String name, int deflt)
static String	getProperty(ESIPropertyRequest request) Returns the ESI property whose key equals the request.getName().
static boolean	getProperty(ESIPropertyRequest request, boolean dflt)
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.
private static boolean	isTrue(String txt, boolean dflt)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

properties

private static Properties properties

PROPERTY_PREFIX

public static final String PROPERTY_PREFIX

See Also:

Constant Field Values

VERBOSE_PROPERTY

private static final String VERBOSE_PROPERTY

See Also:

Constant Field Values

DEBUG_PROPERTY

private static final String DEBUG_PROPERTY

See Also:

Constant Field Values

COLLECTION_SIZE_MULTIPLIER_PROPERTY

private static final String COLLECTION_SIZE_MULTIPLIER_PROPERTY

See Also:

Constant Field Values

VERBOSE

public static boolean VERBOSE

DEBUG

public static boolean DEBUG

COLLECTION_SIZE_MULTIPLIER

public static int COLLECTION_SIZE_MULTIPLIER

Constructor Detail

ESIProperties

public ESIProperties()

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

getCodebasePath

public static String getCodebasePath()

Returns the path to the root ESI directory within the Windchill codebase directory structure.

Supported API: false

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.

Returns:

the value as a boolean.

getProperty

public static boolean getProperty(ESIPropertyRequest request,
                                  boolean dflt)

isTrue

private static boolean isTrue(String txt,
                              boolean dflt)

getIntProperty

public static int getIntProperty(String name,
                                 int deflt)