org.productivity.java.habitat4j.common
Class AbstractPropertyListManager

java.lang.Object
  java.util.Dictionary<K,V>
      java.util.Hashtable
          org.productivity.java.habitat4j.common.AbstractPropertyListManager

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map, Habitat4JConstants

Direct Known Subclasses:

PropertyListManager

public abstract class AbstractPropertyListManager
extends java.util.Hashtable
implements Habitat4JConstants

PropertyListManager provides access to application-wide properties that are loaded contextually based on information gained from the ServerIdentityManager.

The use of Habitat4J starts with the initialization of this Singleton class by your application using the initialize method.

PropertyListManager can manage one or more lists, accessed by a PropertyList symbolic name.

## LICENSE INFORMATION ##

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

Version:

$Id: AbstractPropertyListManager.html,v 1.2 2008/11/24 15:15:06 cvs Exp $

Author:

Justin Yunke <habitat4j@productivity.org>

See Also:

Serialized Form

Field Summary

protected Habitat4JLogger

logger

Fields inherited from interface org.productivity.java.habitat4j.common.Habitat4JConstants

EOL_SEQUENCE, HABITAT4J_APPNAME_ATTRIBUTE_NAME, HABITAT4J_APPNAME_DEFAULT, HABITAT4J_CONTEXT_APPLICATION_NAME, HABITAT4J_CONTEXT_ENVIRONMENT, HABITAT4J_CONTEXT_INSTANCE_DESCRIPTION, HABITAT4J_CONTEXT_INSTANCE_ENUMERATION, HABITAT4J_CONTEXT_INSTANCE_NAME, HABITAT4J_CONTEXT_INSTANCE_OS, HABITAT4J_CONTEXT_LEGAL_ROLE_NAMES, HABITAT4J_CONTEXT_PREFIX, HABITAT4J_CONTEXT_ROLE_NAME, HABITAT4J_CONTEXT_ROLE_PATCH_LEVEL, HABITAT4J_CONTEXT_ROLE_PRODUCT, HABITAT4J_CONTEXT_ROLE_TYPE, HABITAT4J_CONTEXT_ROLE_VENDOR, HABITAT4J_CONTEXT_ROLE_VERSION, HABITAT4J_DEFINITIONS_PACKAGE, HABITAT4J_GENERIC_VALUE_DEFAULT, HABITAT4J_GENERIC_VALUE_EMPTY_STRING, HABITAT4J_GENERIC_VALUE_FALSE, HABITAT4J_GENERIC_VALUE_NO, HABITAT4J_GENERIC_VALUE_OFF, HABITAT4J_GENERIC_VALUE_ON, HABITAT4J_GENERIC_VALUE_ONE, HABITAT4J_GENERIC_VALUE_TRUE, HABITAT4J_GENERIC_VALUE_YES, HABITAT4J_GENERIC_VALUE_ZERO, HABITAT4J_HIDDEN_FIELD_DECODED, HABITAT4J_HIDDEN_FIELD_DECODED_DECRYPTED, HABITAT4J_HIDDEN_FIELD_DECRYPTED, HABITAT4J_LOG4J_LOGGER, HABITAT4J_LOG4J_LOGMANAGER_CLASS, HABITAT4J_LOG4J_LOGMANAGER_GETLOGGER_METHOD, HABITAT4J_PRAGMA_ATTRIBUTE_NAME, HABITAT4J_PRAGMA_ATTRIBUTE_VALUE, HABITAT4J_PROPERTY_ARRAY_INSTANCE_ATTRIBUTE_NAME, HABITAT4J_PROPERTY_ARRAY_INSTANCE_ATTRIBUTE_VALUE_APPEND, HABITAT4J_PROPERTY_ARRAY_INSTANCE_ATTRIBUTE_VALUE_DEFAULT, HABITAT4J_PROPERTY_ARRAY_INSTANCE_ATTRIBUTE_VALUE_PREPEND, HABITAT4J_PROPERTY_ARRAY_INSTANCE_ATTRIBUTE_VALUE_REPLACE, HABITAT4J_PROPERTY_ARRAY_ITEM_METHOD_PREFIX, HABITAT4J_PROPERTY_BEAN_ARRAY_INIT_METHOD_PREFIX, HABITAT4J_PROPERTY_BEAN_ARRAY_INSTANCE_ATTRIBUTE_VALUE_APPEND, HABITAT4J_PROPERTY_BEAN_ARRAY_INSTANCE_ATTRIBUTE_VALUE_DEFAULT, HABITAT4J_PROPERTY_BEAN_ARRAY_INSTANCE_ATTRIBUTE_VALUE_PREPEND, HABITAT4J_PROPERTY_BEAN_ARRAY_INSTANCE_ATTRIBUTE_VALUE_REPLACE, HABITAT4J_PROPERTY_BEAN_ARRAY_ITEM_INIT_METHOD_PREFIX, HABITAT4J_PROPERTY_BEAN_ARRAY_ITEM_SETTER_METHOD_PREFIX, HABITAT4J_PROPERTY_BEAN_ARRAY_SETTER_METHOD_PREFIX, HABITAT4J_PROPERTY_BEAN_DESCRIPTOR_CLASS_ATTRIBUTE_NAME, HABITAT4J_PROPERTY_BEAN_DESCRIPTOR_COPY_METHOD_ATTRIBUTE_NAME, HABITAT4J_PROPERTY_BEAN_DESCRIPTOR_COPY_METHOD_VALUE_DEFAULT, HABITAT4J_PROPERTY_BEAN_DESCRIPTOR_COPY_METHOD_VALUE_REFLECT, HABITAT4J_PROPERTY_BEAN_DESCRIPTOR_COPY_METHOD_VALUE_SERIALIZE, HABITAT4J_PROPERTY_BEAN_DESCRIPTOR_ID_ATTRIBUTE_NAME, HABITAT4J_PROPERTY_BEAN_HASH_INIT_METHOD_PREFIX, HABITAT4J_PROPERTY_BEAN_HASH_INSTANCE_ATTRIBUTE_VALUE_DEFAULT, HABITAT4J_PROPERTY_BEAN_HASH_INSTANCE_ATTRIBUTE_VALUE_REPLACE, HABITAT4J_PROPERTY_BEAN_HASH_INSTANCE_ATTRIBUTE_VALUE_REVISE, HABITAT4J_PROPERTY_BEAN_HASH_ITEM_INIT_METHOD_PREFIX, HABITAT4J_PROPERTY_BEAN_HASH_ITEM_SETTER_METHOD_PREFIX, HABITAT4J_PROPERTY_BEAN_HASH_SETTER_METHOD_PREFIX, HABITAT4J_PROPERTY_BEAN_ID_ATTRIBUTE_NAME, HABITAT4J_PROPERTY_BEAN_INIT_METHOD_PREFIX, HABITAT4J_PROPERTY_BEAN_INSTANCE_ATTRIBUTE_NAME, HABITAT4J_PROPERTY_BEAN_INSTANCE_ATTRIBUTE_VALUE_DEFAULT, HABITAT4J_PROPERTY_BEAN_INSTANCE_ATTRIBUTE_VALUE_REPLACE, HABITAT4J_PROPERTY_BEAN_INSTANCE_ATTRIBUTE_VALUE_REVISE, HABITAT4J_PROPERTY_BEAN_NAME_ATTRIBUTE_NAME, HABITAT4J_PROPERTY_BEAN_SETTER_METHOD_PREFIX, HABITAT4J_PROPERTY_BEAN_VALUE_ATTRIBUTE_NAME, HABITAT4J_PROPERTY_DECODING_ATTRIBUTE_NAME, HABITAT4J_PROPERTY_DECRYPTING_ATTRIBUTE_NAME, HABITAT4J_PROPERTY_HASH_INSTANCE_ATTRIBUTE_NAME, HABITAT4J_PROPERTY_HASH_INSTANCE_ATTRIBUTE_VALUE_DEFAULT, HABITAT4J_PROPERTY_HASH_INSTANCE_ATTRIBUTE_VALUE_REPLACE, HABITAT4J_PROPERTY_HASH_INSTANCE_ATTRIBUTE_VALUE_REVISE, HABITAT4J_PROPERTY_HASH_ITEM_METHOD_PREFIX, HABITAT4J_PROPERTY_HASH_KEY_ATTRIBUTE_NAME, HABITAT4J_PROPERTY_HASH_TYPE_ATTRIBUTE_NAME, HABITAT4J_PROPERTY_KIND_HABITAT4J, HABITAT4J_PROPERTY_KIND_SECURITY, HABITAT4J_PROPERTY_KIND_SYSTEM, HABITAT4J_PROPERTY_LIST_NAME_DEFAULT, HABITAT4J_PROPERTY_LIST_TO_STRING_ITEMS_PER_LINE_DEFAULT, HABITAT4J_PROPERTY_LIST_XSD_RESOURCE_PATH_DEFAULT, HABITAT4J_PROPERTY_NAME_ATTRIBUTE_NAME, HABITAT4J_PROPERTY_TYPE_DELIMITER, HABITAT4J_PROPERTY_VALUE_ATTRIBUTE_NAME, HABITAT4J_PROPERTY_VALUE_SUBSTITUTION_DELIMITER, HABITAT4J_PROPERTY_VALUE_SUBSTITUTION_PREFIX, HABITAT4J_PROPERTY_VALUE_SUBSTITUTION_SUFFIX, HABITAT4J_ROLE_ATTRIBUTE_NAME, HABITAT4J_SAX_DRIVER_DEFAULT, HABITAT4J_SAX_DRIVER_SYSTEM_PROPERTY_NAME, HABITAT4J_SAX_SCHEMA_FEATURE, HABITAT4J_SAX_VALIDATION_FEATURE, HABITAT4J_SAX_XSD_LOCATION, HABITAT4J_SERVER_IDENTITY_FILE_PATH_DEFAULT, HABITAT4J_SERVER_IDENTITY_FILE_PATH_SYSTEM_PROPERTY_NAME, HABITAT4J_SERVER_IDENTITY_XSD_RESOURCE_PATH_DEFAULT, HABITAT4J_TEMP_PROPERTY_LIST_PREFIX, HABITAT4J_UNIX_OS_NAME_LIST_PROPERTY_NAME, HABITAT4J_VERSION, HABITAT4J_WINDOWS_OS_NAME_LIST_PROPERTY_NAME, HABITAT4J_XML_ELEMENT_DELIMITER, SAX_DRIVER_SYSTEM_PROPERTY_NAME, SERVER_IDENTITY_INSTANCE_OS_OTHER, SERVER_IDENTITY_INSTANCE_OS_UNIX, SERVER_IDENTITY_INSTANCE_OS_WINDOWS, SERVER_IDENTITY_MODE_FILE, SERVER_IDENTITY_MODE_JVM, SERVER_IDENTITY_MODE_JVM_ENVIRONMENT, SERVER_IDENTITY_MODE_JVM_INSTANCE_DESCRIPTION, SERVER_IDENTITY_MODE_JVM_INSTANCE_ENUMERATION, SERVER_IDENTITY_MODE_JVM_INSTANCE_NAME, SERVER_IDENTITY_MODE_NULL, SYSTEM_PROPERTY_OS_NAME

Constructor Summary

AbstractPropertyListManager()

Method Summary

protected void	_addGlobalDecoderDefinition(java.lang.String id, java.lang.Class decoderClass)
protected void	_addGlobalDecoderDefinition(java.lang.String id, java.lang.Object decoderObject)
protected void	_addGlobalDecryptorDefinition(java.lang.String id, java.lang.Object decryptorObject)
protected void	_addGlobalDecrytorDefinition(java.lang.String id, java.lang.Class decryptorClass)
protected void	_addGlobalPropertyBeanDefinition(java.lang.String id, java.lang.Class propertyBeanClass)
protected void	_addReloadablePropertyList(java.lang.String propertyListName)
protected void	_clearReloadablePropertyLists()
protected java.lang.Object	_getGlobalReloadEventHandler()
protected java.util.Enumeration	_getProperties() This method is used to obtain a list of all properties from the "default" PropertyList.
protected java.util.Enumeration	_getProperties(java.lang.String propertyListName) This method is used to obtain a list of all properties from the PropertyList specified by the propertyListName parameter.
protected java.lang.String	_getProperty(java.lang.String name) This method is used to obtain a property's String value from the default PropertyList.
protected java.lang.String	_getProperty(java.lang.String propertyListName, java.lang.String name) This method is used to obtain properties from a particular PropertyList.
protected java.lang.String[]	_getPropertyArray(java.lang.String name) This method is used to obtain a property's array of String values from the default PropertyList.
protected java.lang.String[]	_getPropertyArray(java.lang.String propertyListName, java.lang.String name) This method is used to obtain a property's array of String values from a particular PropertyList.
protected int	_getPropertyAsInt(java.lang.String name) This method is used to obtain a property's int value from the default PropertyList.
protected int	_getPropertyAsInt(java.lang.String propertyListName, java.lang.String name) This method is used to obtain properties from a particular PropertyList.
protected java.lang.Object	_getPropertyBean(java.lang.String name) This method returns an instance of a PropertyBean from the default PropertyList.
protected java.lang.Object	_getPropertyBean(java.lang.String propertyListName, java.lang.String name) This method returns an instance of a PropertyBean from a particular PropertyList.
protected java.lang.Object[]	_getPropertyBeanArray(java.lang.String name) This method is used to obtain a property's array of String values from the default PropertyList.
protected java.lang.Object[]	_getPropertyBeanArray(java.lang.String propertyListName, java.lang.String name) This method is used to obtain a property's array of String values from a particular PropertyList.
protected java.lang.Object[]	_getPropertyBeanArrayCopy(java.lang.String name) This method is used to obtain a property's array of String values from the default PropertyList.
protected java.lang.Object[]	_getPropertyBeanArrayCopy(java.lang.String propertyListName, java.lang.String name) This method is used to obtain a property's array of String values from a particular PropertyList.
protected java.lang.Object	_getPropertyBeanCopy(java.lang.String name) This method returns an instance of a PropertyBean from the default PropertyList.
protected java.lang.Object	_getPropertyBeanCopy(java.lang.String propertyListName, java.lang.String name) This method returns an instance of a PropertyBean from a particular PropertyList.
protected PropertyBeanHash	_getPropertyBeanHash(java.lang.String name) This method returns an instance of a PropertyBean from the default PropertyList.
protected PropertyBeanHash	_getPropertyBeanHash(java.lang.String propertyListName, java.lang.String name) This method returns an instance of a PropertyBean from a particular PropertyList.
protected PropertyBeanHash	_getPropertyBeanHashCopy(java.lang.String name) This method is used to obtain a property's array of String values from the default PropertyList.
protected PropertyBeanHash	_getPropertyBeanHashCopy(java.lang.String propertyListName, java.lang.String name) This method is used to obtain a property's array of String values from a particular PropertyList.
protected java.lang.Object	_getPropertyBeanHashValue(java.lang.String name, java.lang.String key) This method is used to obtain a property's hash of String values from a particular PropertyList.
protected java.lang.Object	_getPropertyBeanHashValue(java.lang.String propertyListName, java.lang.String name, java.lang.String key) This method is used to obtain a property's hash of String values from a particular PropertyList.
protected java.lang.Object	_getPropertyBeanHashValueCopy(java.lang.String name, java.lang.String key) This method is used to obtain a property's hash of String values from a particular PropertyList.
protected java.lang.Object	_getPropertyBeanHashValueCopy(java.lang.String propertyListName, java.lang.String name, java.lang.String key) This method is used to obtain a property's hash of String values from a particular PropertyList.
protected java.lang.Class	_getPropertyClass(java.lang.String name) This method gets a property's class from the default PropertyList.
protected java.lang.Class	_getPropertyClass(java.lang.String propertyListName, java.lang.String name) This method gets a property's class from a particular PropertyList.
protected java.lang.String	_getPropertyClassName(java.lang.String name) This method gets a property's classname from the default PropertyList.
protected java.lang.String	_getPropertyClassName(java.lang.String propertyListName, java.lang.String name) This method gets a property's classname from a particular PropertyList.
protected PropertyHash	_getPropertyHash(java.lang.String name) This method is used to obtain a property's hash of String values from the default PropertyList.
protected PropertyHash	_getPropertyHash(java.lang.String propertyListName, java.lang.String name) This method is used to obtain a property's hash of String values from a particular PropertyList.
protected java.util.Properties	_getPropertyHashAsJavaProperties(java.lang.String name) This method is used to obtain a property's hash of String values from the default PropertyList.
protected java.util.Properties	_getPropertyHashAsJavaProperties(java.lang.String propertyListName, java.lang.String name) This method is used to obtain a property's hash of String values from a particular PropertyList.
protected java.lang.String	_getPropertyHashValue(java.lang.String name, java.lang.String key) This method is used to obtain a property's hash of String values from a particular PropertyList.
protected java.lang.String	_getPropertyHashValue(java.lang.String propertyListName, java.lang.String name, java.lang.String key) This method is used to obtain a property's hash of String values from a particular PropertyList.
protected PropertyList	_getPropertyList() This method is used to obtain the default instance of PropertyList.
protected PropertyList	_getPropertyList(java.lang.String propertyListName) This method is used to obtain the instance of PropertyList specified by the propertyListName parameter.
protected java.lang.String	_getPropertyListModifiedBy() This method returns the "modified by" of the default PropertyList.
protected java.lang.String	_getPropertyListModifiedBy(java.lang.String propertyListName) This method returns the "modified by" of the PropertyList.
protected int	_getPropertyListReloadSerial() This method returns the reload serial enumeration of the default PropertyList.
protected int	_getPropertyListReloadSerial(java.lang.String propertyListName) This method returns the reload serial enumeration of the PropertyList.
protected java.lang.String	_getPropertyListVersion() This method returns the version of the default PropertyList.
protected java.lang.String	_getPropertyListVersion(java.lang.String propertyListName) This method returns the version of the PropertyList.
protected ServerIdentity	_getServerIdentity()
protected void	_inhibitReload()
protected void	_inhibitReload(long expiration)
protected void	_initialize(java.lang.String applicationName, AbstractServerIdentityManager serverIdentityManager) This method will initialize the ServerIdentityManager and generate the Singleton instance of this class.
protected void	_initialize(java.lang.String applicationName, AbstractServerIdentityManager serverIdentityManager, java.lang.String mode) This method will initialize the ServerIdentityManager and generate the Singleton instance of this class.
protected void	_initialize(java.lang.String applicationName, AbstractServerIdentityManager serverIdentityManager, java.lang.String mode, ServerIdentityXMLMap map) This method will initialize the ServerIdentityManager and generate the Singleton instance of this class.
protected boolean	_isInitialized() This method is used to determine whether the default PropertyList instance has been initialized.
protected boolean	_isInitialized(java.lang.String propertyListName) This method is used to determine whether PropertyListManager has been successfully initialized.
protected boolean	_isPropertyABean(java.lang.String name) This method returns whether a property contains an instance of a PropertyBean Object.
protected boolean	_isPropertyABean(java.lang.String propertyListName, java.lang.String name) This method returns whether a property contains an instance of a PropertyBean Object.
protected boolean	_isPropertyABeanArray(java.lang.String name) This method returns whether a property contains an array of PropertyBean Objects.
protected boolean	_isPropertyABeanArray(java.lang.String propertyListName, java.lang.String name) This method returns whether a property contains an array of PropertyBean Objects.
protected boolean	_isPropertyABeanHash(java.lang.String name) This method returns whether a property contains an array of PropertyBean Objects.
protected boolean	_isPropertyABeanHash(java.lang.String propertyListName, java.lang.String name) This method returns whether a property contains an array of PropertyBean Objects.
protected boolean	_isPropertyAHash(java.lang.String name) This method returns whether a property from the default PropertyList contains a hash of Strings.
protected boolean	_isPropertyAHash(java.lang.String propertyListName, java.lang.String name) This method returns whether a property contains a hash of String values.
protected boolean	_isPropertyAnArray(java.lang.String name) This method returns whether a property from the default PropertyList contains an array of Strings.
protected boolean	_isPropertyAnArray(java.lang.String propertyListName, java.lang.String name) This method returns whether a property contains an array of String values.
protected boolean	_isPropertyAString(java.lang.String name) This method returns whether a property contains a String value.
protected boolean	_isPropertyAString(java.lang.String propertyListName, java.lang.String name) This method returns whether a property contains a String value.
protected boolean	_isPropertyHashValueSet(java.lang.String name, java.lang.String key) This method is used to obtain a property's hash of String values from a particular PropertyList.
protected boolean	_isPropertyHashValueSet(java.lang.String propertyListName, java.lang.String name, java.lang.String key) This method is used to obtain a property's hash of String values from a particular PropertyList.
protected boolean	_isPropertyTrue(java.lang.String name) This method is used to obtain a property's int value from the default PropertyList.
protected boolean	_isPropertyTrue(java.lang.String propertyListName, java.lang.String name) This method is used to obtain properties from a particular PropertyList.
protected boolean	_isReloadablePropertyList(java.lang.String propertyListName)
protected void	_loadPropertyList(java.lang.String propertyListPath) This wrapper method tries to find a given propertyListPath as a classpath resource, then as a file resource, and then loads it.
protected void	_loadPropertyList(java.lang.String propertyListPath, PropertyListXMLMap map) This wrapper method tries to find a given propertyListPath as a classpath resource, then as a file resource, and then loads it.
protected void	_loadPropertyList(java.lang.String propertyListName, java.lang.String propertyListPath) This wrapper method tries to find a given propertyListPath as a classpath resource, then as a file resource, and then loads it.
protected void	_loadPropertyList(java.lang.String propertyListName, java.lang.String propertyListPath, PropertyListXMLMap map) This wrapper method tries to find a given propertyListPath as a classpath resource, then as a file resource, and then loads it.
protected void	_loadPropertyListFromFile(java.lang.String propertyListFilePath) This method is used to retrieve a PropertyList from a file, using the "default" PropertyList symbolic name.
protected void	_loadPropertyListFromFile(java.lang.String propertyListFilePath, PropertyListXMLMap map) This method is used to retrieve a PropertyList from a file, using the "default" PropertyList symbolic name.
protected void	_loadPropertyListFromFile(java.lang.String propertyListName, java.lang.String propertyListFilePath, boolean tempPropertyList) This method is called by your application to retrieve a PropertyList from a file using the symbolic name specified by the propertyListName argument.
protected void	_loadPropertyListFromFile(java.lang.String propertyListName, java.lang.String propertyListFilePath, boolean tempPropertyList, PropertyListXMLMap map) This method is called by your application to retrieve a PropertyList from a file using the symbolic name specified by the propertyListName argument.
protected void	_loadPropertyListFromFile(java.lang.String propertyListName, java.lang.String propertyListFilePath, PropertyListXMLMap map) This method is used to retrieve a PropertyList from a file, using the specified PropertyList name.
protected void	_loadPropertyListFromResource(java.lang.String propertyListResourcePath) This method is called by your application to retrieve a PropertyList from a classpath resource, using the "default" PropertyList symbolic name.
protected void	_loadPropertyListFromResource(java.lang.String propertyListResourcePath, PropertyListXMLMap map) This method is called by your application to retrieve a PropertyList from a classpath resource, using the "default" PropertyList symbolic name.
protected void	_loadPropertyListFromResource(java.lang.String propertyListName, java.lang.String propertyListResourcePath) This method is used to retrieve a PropertyList from a classpath resource using the symbolic name specified by the propertyListName argument.
protected void	_loadPropertyListFromResource(java.lang.String propertyListName, java.lang.String propertyListResourcePath, PropertyListXMLMap map) This method is used to retrieve a PropertyList from a classpath resource using the symbolic name specified by the propertyListName argument.
protected void	_reloadOnFileChange() This method reloads a file-based XML document based on file change.
protected void	_reloadOnFileChange(java.lang.String propertyListName) This method reloads a file-based XML document based on file change.
protected void	_removePropertyList(java.lang.String propertyListName) This method removes a PropertyList.
protected void	_removeReloadablePropertyList(java.lang.String propertyListName)
protected void	_renamePropertyList(java.lang.String oldPropertyListName, java.lang.String newPropertyListName) This method renames a particular PropertyList instance.
protected void	_setFeature(java.lang.String name, boolean value) This method sets Habitat4J features.
protected void	_setFeature(java.lang.String name, int value) This method sets Habitat4J features.
protected void	_setFeature(java.lang.String name, java.lang.String value) This method sets Habitat4J features.
protected void	_setGlobalReloadEventHandler(java.lang.Object globalReloadEventHandler)
protected void	_setPragmaDefinition(java.lang.String name, java.lang.String value)
protected void	_setPragmaDefinition(java.lang.String propertyListName, java.lang.String name, java.lang.String value)
protected java.lang.String	_toDisplayString() This method is used to produce a human-readable list of all PropertyList instances.
protected void	_uninhibitReload()
protected void	checkThatPropertyListExists(java.lang.String propertyListName)
protected void	checkThatPropertyListExists(java.lang.String propertyListName, java.lang.String name)
protected void	throwPropertyNotAvailableExceptionBecauseListNotInitialized(java.lang.String propertyListName, java.lang.String name)

Methods inherited from class java.util.Hashtable

clear, clone, contains, containsKey, containsValue, elements, entrySet, equals, get, hashCode, isEmpty, keys, keySet, put, putAll, rehash, remove, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

logger

protected Habitat4JLogger logger

Constructor Detail

AbstractPropertyListManager

public AbstractPropertyListManager()

Method Detail

_getProperties

protected java.util.Enumeration _getProperties()
                                        throws PropertyNotAvailableException

This method is used to obtain a list of all properties from the "default" PropertyList.

Returns:

Returns an Enumeration of the list of property names

Throws:

PropertyNotAvailableException

_getProperties

protected java.util.Enumeration _getProperties(java.lang.String propertyListName)
                                        throws PropertyNotAvailableException

This method is used to obtain a list of all properties from the PropertyList specified by the propertyListName parameter.

Parameters:

propertyListName - the PropertyList instance from which to retrieve

Returns:

Returns an Enumeration of the list of property names

Throws:

PropertyNotAvailableException

_getProperty

protected java.lang.String _getProperty(java.lang.String name)
                                 throws PropertyNotAvailableException

This method is used to obtain a property's String value from the default PropertyList.

Parameters:

name - - the name of the property

Returns:

Returns the value of a property from the default PropertyList.

Throws:

PropertyNotAvailableException

_getProperty

protected java.lang.String _getProperty(java.lang.String propertyListName,
                                        java.lang.String name)
                                 throws PropertyNotAvailableException

This method is used to obtain properties from a particular PropertyList.

Parameters:

propertyListName - - the name of the PropertyList

name - - the name of the property

Returns:

Returns the value of a property from a particular PropertyList.

Throws:

PropertyNotAvailableException

_getPropertyAsInt

protected int _getPropertyAsInt(java.lang.String propertyListName,
                                java.lang.String name)
                         throws PropertyNotAvailableException

This method is used to obtain properties from a particular PropertyList.

Parameters:

propertyListName - - the name of the PropertyList

name - - the name of the property

Returns:

Returns the primitive int value of a property from a particular PropertyList.

Throws:

PropertyNotAvailableException

_getPropertyAsInt

protected int _getPropertyAsInt(java.lang.String name)
                         throws PropertyNotAvailableException

This method is used to obtain a property's int value from the default PropertyList.

Parameters:

name - - the name of the property

Returns:

Returns the primitive int value of a property from the default PropertyList.

Throws:

PropertyNotAvailableException

_isPropertyTrue

protected boolean _isPropertyTrue(java.lang.String propertyListName,
                                  java.lang.String name)
                           throws PropertyNotAvailableException

This method is used to obtain properties from a particular PropertyList.

Parameters:

propertyListName - - the name of the PropertyList

name - - the name of the property

Returns:

Returns the primitive boolean value of a property from a particular PropertyList.

Throws:

PropertyNotAvailableException

_isPropertyTrue

protected boolean _isPropertyTrue(java.lang.String name)
                           throws PropertyNotAvailableException

This method is used to obtain a property's int value from the default PropertyList.

Parameters:

name - - the name of the property

Returns:

Returns the primitive boolean value of a property from the default PropertyList.

Throws:

PropertyNotAvailableException

_getPropertyArray

protected java.lang.String[] _getPropertyArray(java.lang.String name)
                                        throws PropertyNotAvailableException

This method is used to obtain a property's array of String values from the default PropertyList.

Parameters:

name - - the name of the property

Returns:

Returns an array of String values from a property from the default PropertyList.

Throws:

PropertyNotAvailableException

_getPropertyArray

protected java.lang.String[] _getPropertyArray(java.lang.String propertyListName,
                                               java.lang.String name)
                                        throws PropertyNotAvailableException

This method is used to obtain a property's array of String values from a particular PropertyList.

Parameters:

propertyListName - - the name of the PropertyList

name - - the name of the property

Returns:

Returns an array of String values from a property from a particular PropertyList.

Throws:

PropertyNotAvailableException

_getPropertyHash

protected PropertyHash _getPropertyHash(java.lang.String name)
                                 throws PropertyNotAvailableException

This method is used to obtain a property's hash of String values from the default PropertyList.

Parameters:

name - - the name of the property

Returns:

Returns a hash of String values from a property from the default PropertyList.

Throws:

PropertyNotAvailableException

_getPropertyHash

protected PropertyHash _getPropertyHash(java.lang.String propertyListName,
                                        java.lang.String name)
                                 throws PropertyNotAvailableException

This method is used to obtain a property's hash of String values from a particular PropertyList.

Parameters:

propertyListName - - the name of the PropertyList

name - - the name of the property

Returns:

Returns a hash of String values from a property from a particular PropertyList.

Throws:

PropertyNotAvailableException

_getPropertyHashAsJavaProperties

protected java.util.Properties _getPropertyHashAsJavaProperties(java.lang.String name)
                                                         throws PropertyNotAvailableException

This method is used to obtain a property's hash of String values from the default PropertyList.

Parameters:

name - - the name of the property

Returns:

Returns a hash of String values from a property from the default PropertyList.

Throws:

PropertyNotAvailableException

_getPropertyHashAsJavaProperties

protected java.util.Properties _getPropertyHashAsJavaProperties(java.lang.String propertyListName,
                                                                java.lang.String name)
                                                         throws PropertyNotAvailableException

This method is used to obtain a property's hash of String values from a particular PropertyList.

Parameters:

propertyListName - - the name of the PropertyList

name - - the name of the property

Returns:

Returns a hash of String values from a property from a particular PropertyList.

Throws:

PropertyNotAvailableException

_getPropertyHashValue

protected java.lang.String _getPropertyHashValue(java.lang.String name,
                                                 java.lang.String key)
                                          throws PropertyNotAvailableException

This method is used to obtain a property's hash of String values from a particular PropertyList.

Parameters:

name - - the name of the property

key - - the key to lookup in the PropertyHash

Returns:

Returns a String value from the PropertyHash.

Throws:

PropertyNotAvailableException

_getPropertyHashValue

protected java.lang.String _getPropertyHashValue(java.lang.String propertyListName,
                                                 java.lang.String name,
                                                 java.lang.String key)
                                          throws PropertyNotAvailableException

This method is used to obtain a property's hash of String values from a particular PropertyList.

Parameters:

propertyListName - - the name of the PropertyList

name - - the name of the property

key - - the key to lookup in the PropertyHash

Returns:

Returns a String value from the PropertyHash.

Throws:

PropertyNotAvailableException

_getPropertyBeanHashValue

protected java.lang.Object _getPropertyBeanHashValue(java.lang.String name,
                                                     java.lang.String key)
                                              throws PropertyNotAvailableException

This method is used to obtain a property's hash of String values from a particular PropertyList.

Parameters:

name - - the name of the property

key - - the key to lookup in the PropertyHash

Returns:

Returns a String value from the PropertyHash.

Throws:

PropertyNotAvailableException

_getPropertyBeanHashValue

protected java.lang.Object _getPropertyBeanHashValue(java.lang.String propertyListName,
                                                     java.lang.String name,
                                                     java.lang.String key)
                                              throws PropertyNotAvailableException

This method is used to obtain a property's hash of String values from a particular PropertyList.

Parameters:

propertyListName - - the name of the PropertyList

name - - the name of the property

key - - the key to lookup in the PropertyHash

Returns:

Returns a String value from the PropertyHash.

Throws:

PropertyNotAvailableException

_getPropertyBeanHashValueCopy

protected java.lang.Object _getPropertyBeanHashValueCopy(java.lang.String name,
                                                         java.lang.String key)
                                                  throws PropertyNotAvailableException

This method is used to obtain a property's hash of String values from a particular PropertyList.

Parameters:

name - - the name of the property

key - - the key to lookup in the PropertyHash

Returns:

Returns a String value from the PropertyHash.

Throws:

PropertyNotAvailableException

_getPropertyBeanHashValueCopy

protected java.lang.Object _getPropertyBeanHashValueCopy(java.lang.String propertyListName,
                                                         java.lang.String name,
                                                         java.lang.String key)
                                                  throws PropertyNotAvailableException

This method is used to obtain a property's hash of String values from a particular PropertyList.

Parameters:

propertyListName - - the name of the PropertyList

name - - the name of the property

key - - the key to lookup in the PropertyHash

Returns:

Returns a String value from the PropertyHash.

Throws:

PropertyNotAvailableException

_isPropertyHashValueSet

protected boolean _isPropertyHashValueSet(java.lang.String name,
                                          java.lang.String key)
                                   throws PropertyNotAvailableException

This method is used to obtain a property's hash of String values from a particular PropertyList.

Parameters:

name - - the name of the property

key - - the key to lookup in the PropertyHash

Returns:

Returns a String value from the PropertyHash.

Throws:

PropertyNotAvailableException

_isPropertyHashValueSet

protected boolean _isPropertyHashValueSet(java.lang.String propertyListName,
                                          java.lang.String name,
                                          java.lang.String key)
                                   throws PropertyNotAvailableException

This method is used to obtain a property's hash of String values from a particular PropertyList.

Parameters:

propertyListName - - the name of the PropertyList

name - - the name of the property

key - - the key to lookup in the PropertyHash

Returns:

Returns a String value from the PropertyHash.

Throws:

PropertyNotAvailableException

_getPropertyBean

protected java.lang.Object _getPropertyBean(java.lang.String name)
                                     throws PropertyNotAvailableException

This method returns an instance of a PropertyBean from the default PropertyList.

Parameters:

name - - the name of the property

Returns:

Returns an instance of a PropertyBean.

Throws:

PropertyNotAvailableException

_getPropertyBean

protected java.lang.Object _getPropertyBean(java.lang.String propertyListName,
                                            java.lang.String name)
                                     throws PropertyNotAvailableException

This method returns an instance of a PropertyBean from a particular PropertyList.

Parameters:

propertyListName - - the name of the PropertyList

name - - the name of the property

Returns:

Returns an instance of a PropertyBean.

Throws:

PropertyNotAvailableException

_getPropertyBeanHash

protected PropertyBeanHash _getPropertyBeanHash(java.lang.String name)
                                         throws PropertyNotAvailableException

This method returns an instance of a PropertyBean from the default PropertyList.

Parameters:

name - - the name of the property

Returns:

Returns an instance of a PropertyBean.

Throws:

PropertyNotAvailableException

_getPropertyBeanHash

protected PropertyBeanHash _getPropertyBeanHash(java.lang.String propertyListName,
                                                java.lang.String name)
                                         throws PropertyNotAvailableException

This method returns an instance of a PropertyBean from a particular PropertyList.

Parameters:

propertyListName - - the name of the PropertyList

name - - the name of the property

Returns:

Returns an instance of a PropertyBean.

Throws:

PropertyNotAvailableException

_getPropertyBeanCopy

protected java.lang.Object _getPropertyBeanCopy(java.lang.String name)
                                         throws PropertyNotAvailableException

This method returns an instance of a PropertyBean from the default PropertyList. This method differs from the regular _getPropertyBean(..) in that it returns a copy (clone) of the instance that can be modified by the application without altering the stored property.

Parameters:

name - - the name of the property

Returns:

Returns an instance of a PropertyBean.

Throws:

PropertyNotAvailableException

_getPropertyBeanCopy

protected java.lang.Object _getPropertyBeanCopy(java.lang.String propertyListName,
                                                java.lang.String name)
                                         throws PropertyNotAvailableException

This method returns an instance of a PropertyBean from a particular PropertyList. This method differs from the regular _getPropertyBean(..) in that it returns a copy (clone) of the instance that can be modified by the application without altering the stored property.

Parameters:

propertyListName - - the name of the PropertyList

name - - the name of the property

Returns:

Returns an instance of a PropertyBean.

Throws:

PropertyNotAvailableException

_getPropertyBeanArray

protected java.lang.Object[] _getPropertyBeanArray(java.lang.String name)
                                            throws PropertyNotAvailableException

This method is used to obtain a property's array of String values from the default PropertyList.

Parameters:

name - - the name of the property

Returns:

Returns an array of String values from a property from the default PropertyList.

Throws:

PropertyNotAvailableException

_getPropertyBeanArray

protected java.lang.Object[] _getPropertyBeanArray(java.lang.String propertyListName,
                                                   java.lang.String name)
                                            throws PropertyNotAvailableException

This method is used to obtain a property's array of String values from a particular PropertyList.

Parameters:

propertyListName - - the name of the PropertyList

name - - the name of the property

Returns:

Returns an array of String values from a property from a particular PropertyList.

Throws:

PropertyNotAvailableException

_getPropertyBeanArrayCopy

protected java.lang.Object[] _getPropertyBeanArrayCopy(java.lang.String name)
                                                throws PropertyNotAvailableException

This method is used to obtain a property's array of String values from the default PropertyList. This method differs from the regular _getPropertyBeanArray(..) in that it returns a copy (clone) of the array that can be modified by the application without altering the stored PropertyBean Objects.

Parameters:

name - - the name of the property

Returns:

Returns an array of String values from a property from the default PropertyList.

Throws:

PropertyNotAvailableException

_getPropertyBeanArrayCopy

protected java.lang.Object[] _getPropertyBeanArrayCopy(java.lang.String propertyListName,
                                                       java.lang.String name)
                                                throws PropertyNotAvailableException

This method is used to obtain a property's array of String values from a particular PropertyList. This method differs from the regular _getPropertyBeanArray(..) in that it returns a copy (clone) of the array that can be modified by the application without altering the stored PropertyBean Objects.

Parameters:

propertyListName - - the name of the PropertyList

name - - the name of the property

Returns:

Returns an array of String values from a property from a particular PropertyList.

Throws:

PropertyNotAvailableException

_getPropertyBeanHashCopy

protected PropertyBeanHash _getPropertyBeanHashCopy(java.lang.String name)
                                             throws PropertyNotAvailableException

This method is used to obtain a property's array of String values from the default PropertyList. This method differs from the regular _getPropertyBeanArray(..) in that it returns a copy (clone) of the array that can be modified by the application without altering the stored PropertyBean Objects.

Parameters:

name - - the name of the property

Returns:

Returns an array of String values from a property from the default PropertyList.

Throws:

PropertyNotAvailableException

_getPropertyBeanHashCopy

protected PropertyBeanHash _getPropertyBeanHashCopy(java.lang.String propertyListName,
                                                    java.lang.String name)
                                             throws PropertyNotAvailableException

This method is used to obtain a property's array of String values from a particular PropertyList. This method differs from the regular _getPropertyBeanArray(..) in that it returns a copy (clone) of the array that can be modified by the application without altering the stored PropertyBean Objects.

Parameters:

propertyListName - - the name of the PropertyList

name - - the name of the property

Returns:

Returns an array of String values from a property from a particular PropertyList.

Throws:

PropertyNotAvailableException

_getPropertyClass

protected java.lang.Class _getPropertyClass(java.lang.String name)
                                     throws PropertyNotAvailableException

This method gets a property's class from the default PropertyList.

Parameters:

name - - the name of the property

Returns:

Returns the class of the property from the default PropertyList.

Throws:

PropertyNotAvailableException

_getPropertyClass

protected java.lang.Class _getPropertyClass(java.lang.String propertyListName,
                                            java.lang.String name)
                                     throws PropertyNotAvailableException

This method gets a property's class from a particular PropertyList.

Parameters:

propertyListName - - the name of the PropertyList

name - - the name of the property

Returns:

Returns the class of the property from a particular PropertyList.

Throws:

PropertyNotAvailableException

_getPropertyClassName

protected java.lang.String _getPropertyClassName(java.lang.String name)
                                          throws PropertyNotAvailableException

This method gets a property's classname from the default PropertyList.

Parameters:

name - - the name of the property

Returns:

Returns the classname of the property from the default PropertyList.

Throws:

PropertyNotAvailableException

_getPropertyClassName

protected java.lang.String _getPropertyClassName(java.lang.String propertyListName,
                                                 java.lang.String name)
                                          throws PropertyNotAvailableException

This method gets a property's classname from a particular PropertyList.

Parameters:

propertyListName - - the name of the PropertyList

name - - the name of the property

Returns:

Returns the classname of the property from a particular PropertyList.

Throws:

PropertyNotAvailableException

_getPropertyList

protected PropertyList _getPropertyList()

This method is used to obtain the default instance of PropertyList.

Returns:

Returns an Enumeration of the list of property names.

_getPropertyList

protected PropertyList _getPropertyList(java.lang.String propertyListName)

This method is used to obtain the instance of PropertyList specified by the propertyListName parameter.

Parameters:

propertyListName - - the name of the PropertyList

Returns:

Returns an Enumeration of the list of property names.

_renamePropertyList

protected void _renamePropertyList(java.lang.String oldPropertyListName,
                                   java.lang.String newPropertyListName)
                            throws PropertyListHandlerException

This method renames a particular PropertyList instance.

Parameters:

oldPropertyListName - - the name of the PropertyList to rename

newPropertyListName - - the new name of the PropertyList

Throws:

PropertyListHandlerException

_removePropertyList

protected void _removePropertyList(java.lang.String propertyListName)
                            throws PropertyListHandlerException

This method removes a PropertyList.

Parameters:

propertyListName - - the name of the PropertyList to remove

Throws:

PropertyListHandlerException

_getPropertyListModifiedBy

protected java.lang.String _getPropertyListModifiedBy()
                                               throws PropertyNotAvailableException

This method returns the "modified by" of the default PropertyList.

Returns:

Returns the "modified by" of the default PropertyList.

Throws:

PropertyNotAvailableException

_getPropertyListModifiedBy

protected java.lang.String _getPropertyListModifiedBy(java.lang.String propertyListName)
                                               throws PropertyNotAvailableException

This method returns the "modified by" of the PropertyList.

Parameters:

propertyListName - - the name of the PropertyList

Returns:

Returns the "modified by" of the PropertyList.

Throws:

PropertyNotAvailableException

_getPropertyListReloadSerial

protected int _getPropertyListReloadSerial()
                                    throws PropertyNotAvailableException

This method returns the reload serial enumeration of the default PropertyList.

Returns:

Returns the reload serial enumeration of the default PropertyList.

Throws:

PropertyNotAvailableException

_getPropertyListReloadSerial

protected int _getPropertyListReloadSerial(java.lang.String propertyListName)
                                    throws PropertyNotAvailableException

This method returns the reload serial enumeration of the PropertyList.

Parameters:

propertyListName - - the name of the PropertyList

Returns:

Returns the reload serial enumeration of the PropertyList.

Throws:

PropertyNotAvailableException

_getPropertyListVersion

protected java.lang.String _getPropertyListVersion()
                                            throws PropertyNotAvailableException

This method returns the version of the default PropertyList.

Returns:

Returns the version of the default PropertyList.

Throws:

PropertyNotAvailableException

_getPropertyListVersion

protected java.lang.String _getPropertyListVersion(java.lang.String propertyListName)
                                            throws PropertyNotAvailableException

This method returns the version of the PropertyList.

Parameters:

propertyListName - - the name of the PropertyList

Returns:

Returns the version of the PropertyList.

Throws:

PropertyNotAvailableException

_getServerIdentity

protected ServerIdentity _getServerIdentity()

Returns:

Returns the serverIdentity instance.

_initialize

protected void _initialize(java.lang.String applicationName,
                           AbstractServerIdentityManager serverIdentityManager,
                           java.lang.String mode,
                           ServerIdentityXMLMap map)

This method will initialize the ServerIdentityManager and generate the Singleton instance of this class.

Parameters:

applicationName - - the name of the calling application

mode - - the ServerIdentity mode identifier ("N" "F" or "J")

map -

serverIdentityManager - - the instance of ServerIdentityManager

_initialize

protected void _initialize(java.lang.String applicationName,
                           AbstractServerIdentityManager serverIdentityManager,
                           java.lang.String mode)

This method will initialize the ServerIdentityManager and generate the Singleton instance of this class.

Parameters:

applicationName - - the name of the calling application

mode -

serverIdentityManager - - the instance of ServerIdentityManager

_initialize

protected void _initialize(java.lang.String applicationName,
                           AbstractServerIdentityManager serverIdentityManager)

This method will initialize the ServerIdentityManager and generate the Singleton instance of this class.

Parameters:

applicationName - - the name of the calling application

serverIdentityManager - - the instance of ServerIdentityManager

_isInitialized

protected boolean _isInitialized()

This method is used to determine whether the default PropertyList instance has been initialized.

Returns:

Returns whether this instance has been initialized.

_isInitialized

protected boolean _isInitialized(java.lang.String propertyListName)

This method is used to determine whether PropertyListManager has been successfully initialized. It's primarily used within this class to verify a valid instance exists before executing code, but could be used outside of this class.

Parameters:

propertyListName - - the name of the PropertyList instance

Returns:

Returns the status of initialization of PropertyListManager

_isPropertyABean

protected boolean _isPropertyABean(java.lang.String name)
                            throws PropertyNotAvailableException

This method returns whether a property contains an instance of a PropertyBean Object.

Parameters:

name - the name of the property

Returns:

Returns whether the property specified by name contains an instance of a PropertyBean Object.

Throws:

PropertyNotAvailableException

_isPropertyABean

protected boolean _isPropertyABean(java.lang.String propertyListName,
                                   java.lang.String name)
                            throws PropertyNotAvailableException

This method returns whether a property contains an instance of a PropertyBean Object.

Parameters:

propertyListName - - the name of the PropertyList

name - the name of the property

Returns:

Returns whether the property specified by name contains an instance of a PropertyBean Object.

Throws:

PropertyNotAvailableException

_isPropertyABeanArray

protected boolean _isPropertyABeanArray(java.lang.String name)
                                 throws PropertyNotAvailableException

This method returns whether a property contains an array of PropertyBean Objects.

Parameters:

name - the name of the property

Returns:

Returns whether the property specified by name contains an array of PropertyBean Objects.

Throws:

PropertyNotAvailableException

_isPropertyABeanArray

protected boolean _isPropertyABeanArray(java.lang.String propertyListName,
                                        java.lang.String name)
                                 throws PropertyNotAvailableException

This method returns whether a property contains an array of PropertyBean Objects.

Parameters:

propertyListName - - the name of the PropertyList

name - the name of the property

Returns:

Returns whether the property specified by name contains an array of PropertyBean Objects.

Throws:

PropertyNotAvailableException

_isPropertyABeanHash

protected boolean _isPropertyABeanHash(java.lang.String name)
                                throws PropertyNotAvailableException

This method returns whether a property contains an array of PropertyBean Objects.

Parameters:

name - the name of the property

Returns:

Returns whether the property specified by name contains an array of PropertyBean Objects.

Throws:

PropertyNotAvailableException

_isPropertyABeanHash

protected boolean _isPropertyABeanHash(java.lang.String propertyListName,
                                       java.lang.String name)
                                throws PropertyNotAvailableException

This method returns whether a property contains an array of PropertyBean Objects.

Parameters:

propertyListName - - the name of the PropertyList

name - the name of the property

Returns:

Returns whether the property specified by name contains an array of PropertyBean Objects.

Throws:

PropertyNotAvailableException

_isPropertyAnArray

protected boolean _isPropertyAnArray(java.lang.String name)
                              throws PropertyNotAvailableException

This method returns whether a property from the default PropertyList contains an array of Strings.

Parameters:

name - the name of the property

Returns:

Returns whether the property specified by name contains an array of Strings.

Throws:

PropertyNotAvailableException

_isPropertyAnArray

protected boolean _isPropertyAnArray(java.lang.String propertyListName,
                                     java.lang.String name)
                              throws PropertyNotAvailableException

This method returns whether a property contains an array of String values.

Parameters:

propertyListName - - the name of the PropertyList

name - - the name of the property

Returns:

Returns whether the property specified by name contains an array of String values.

Throws:

PropertyNotAvailableException

_isPropertyAHash

protected boolean _isPropertyAHash(java.lang.String name)
                            throws PropertyNotAvailableException

This method returns whether a property from the default PropertyList contains a hash of Strings.

Parameters:

name - the name of the property

Returns:

Returns whether the property specified by name contains a hash of String values.

Throws:

PropertyNotAvailableException

_isPropertyAHash

protected boolean _isPropertyAHash(java.lang.String propertyListName,
                                   java.lang.String name)
                            throws PropertyNotAvailableException

This method returns whether a property contains a hash of String values.

Parameters:

propertyListName - - the name of the PropertyList

name - - the name of the property

Returns:

Returns whether the property specified by name contains a hash of String values.

Throws:

PropertyNotAvailableException

_isPropertyAString

protected boolean _isPropertyAString(java.lang.String name)
                              throws PropertyNotAvailableException

This method returns whether a property contains a String value.

Parameters:

name - - the name of the property

Returns:

Returns whether the property specified by name contains a String value.

Throws:

PropertyNotAvailableException

_isPropertyAString

protected boolean _isPropertyAString(java.lang.String propertyListName,
                                     java.lang.String name)
                              throws PropertyNotAvailableException

This method returns whether a property contains a String value.

Parameters:

propertyListName - - the name of the PropertyList

name - - the name of the property

Returns:

Returns whether the property specified by name contains a String value.

Throws:

PropertyNotAvailableException

_loadPropertyList

protected void _loadPropertyList(java.lang.String propertyListPath,
                                 PropertyListXMLMap map)
                          throws PropertyListHandlerException

This wrapper method tries to find a given propertyListPath as a classpath resource, then as a file resource, and then loads it.

Parameters:

propertyListPath - - the classloader or file path of the PropertyList file

map - - the PropertyListXMLMap to use for compatibility with other schemas

Throws:

PropertyListHandlerException

_loadPropertyList

protected void _loadPropertyList(java.lang.String propertyListName,
                                 java.lang.String propertyListPath,
                                 PropertyListXMLMap map)
                          throws PropertyListHandlerException

This wrapper method tries to find a given propertyListPath as a classpath resource, then as a file resource, and then loads it.

Parameters:

propertyListName - - the name of the PropertyList

propertyListPath - - the classloader or file path of the PropertyList file

map - - the PropertyListXMLMap to use for compatibility with other schemas

Throws:

PropertyListHandlerException

_loadPropertyListFromFile

protected void _loadPropertyListFromFile(java.lang.String propertyListName,
                                         java.lang.String propertyListFilePath,
                                         PropertyListXMLMap map)
                                  throws PropertyListHandlerException

This method is used to retrieve a PropertyList from a file, using the specified PropertyList name. This method can only be called once. Use the method with propertyListName as a parameter to load multiple PropertyList instances.

Parameters:

propertyListName - - the name of the PropertyList

propertyListFilePath - - the path of the PropertyList XML file

map - - the PropertyListXMLMap to use for compatibility with other schemas

Throws:

PropertyListHandlerException

_loadPropertyListFromFile

protected void _loadPropertyListFromFile(java.lang.String propertyListFilePath,
                                         PropertyListXMLMap map)
                                  throws PropertyListHandlerException

This method is used to retrieve a PropertyList from a file, using the "default" PropertyList symbolic name. This method can only be called once. Use the method with propertyListName as a parameter to load multiple PropertyList instances.

Parameters:

propertyListFilePath - - the path of the PropertyList XML file

map - - the PropertyListXMLMap to use for compatibility with other schemas

Throws:

PropertyListHandlerException

_loadPropertyListFromFile

protected void _loadPropertyListFromFile(java.lang.String propertyListName,
                                         java.lang.String propertyListFilePath,
                                         boolean tempPropertyList,
                                         PropertyListXMLMap map)
                                  throws PropertyListHandlerException

This method is called by your application to retrieve a PropertyList from a file using the symbolic name specified by the propertyListName argument.

Parameters:

propertyListName - - the name of the PropertyList

propertyListFilePath - - the path of the PropertyList XML file

tempPropertyList - - marks this PropertyList as a temporary one (used for reloading)

map - - the PropertyListXMLMap to use for compatibility with other schemas

Throws:

PropertyListHandlerException

_loadPropertyListFromResource

protected void _loadPropertyListFromResource(java.lang.String propertyListResourcePath,
                                             PropertyListXMLMap map)
                                      throws PropertyListHandlerException

This method is called by your application to retrieve a PropertyList from a classpath resource, using the "default" PropertyList symbolic name. This method can only be called once. Use the method with propertyListName as a parameter to load multiple PropertyList instances.

Parameters:

propertyListResourcePath - - the classloader path of the PropertyList file

map - - the PropertyListXMLMap to use for compatibility with other schemas

Throws:

PropertyListHandlerException

_loadPropertyListFromResource

protected void _loadPropertyListFromResource(java.lang.String propertyListName,
                                             java.lang.String propertyListResourcePath,
                                             PropertyListXMLMap map)
                                      throws PropertyListHandlerException

This method is used to retrieve a PropertyList from a classpath resource using the symbolic name specified by the propertyListName argument.

Parameters:

propertyListName - - the name of the PropertyList

propertyListResourcePath - - the classloader path of the PropertyList file

map - - the PropertyListXMLMap to use for compatibility with other schemas

Throws:

PropertyListHandlerException

_loadPropertyList

protected void _loadPropertyList(java.lang.String propertyListPath)
                          throws PropertyListHandlerException

This wrapper method tries to find a given propertyListPath as a classpath resource, then as a file resource, and then loads it.

Parameters:

propertyListPath - - the classloader or file path of the PropertyList file

Throws:

PropertyListHandlerException

_loadPropertyList

protected void _loadPropertyList(java.lang.String propertyListName,
                                 java.lang.String propertyListPath)
                          throws PropertyListHandlerException

This wrapper method tries to find a given propertyListPath as a classpath resource, then as a file resource, and then loads it.

Parameters:

propertyListName - - the name of the PropertyList

propertyListPath - - the classloader or file path of the PropertyList file

Throws:

PropertyListHandlerException

_loadPropertyListFromFile

protected void _loadPropertyListFromFile(java.lang.String propertyListFilePath)
                                  throws PropertyListHandlerException

This method is used to retrieve a PropertyList from a file, using the "default" PropertyList symbolic name. This method can only be called once. Use the method with propertyListName as a parameter to load multiple PropertyList instances.

Parameters:

propertyListFilePath - - the path of the PropertyList XML file

Throws:

PropertyListHandlerException

_loadPropertyListFromFile

protected void _loadPropertyListFromFile(java.lang.String propertyListName,
                                         java.lang.String propertyListFilePath,
                                         boolean tempPropertyList)
                                  throws PropertyListHandlerException

This method is called by your application to retrieve a PropertyList from a file using the symbolic name specified by the propertyListName argument.

Parameters:

propertyListName - - the name of the PropertyList

propertyListFilePath - - the path of the PropertyList XML file

tempPropertyList - - marks this PropertyList as a temporary one (used for reloading)

Throws:

PropertyListHandlerException

_loadPropertyListFromResource

protected void _loadPropertyListFromResource(java.lang.String propertyListResourcePath)
                                      throws PropertyListHandlerException

This method is called by your application to retrieve a PropertyList from a classpath resource, using the "default" PropertyList symbolic name. This method can only be called once. Use the method with propertyListName as a parameter to load multiple PropertyList instances.

Parameters:

propertyListResourcePath - - the classloader path of the PropertyList file

Throws:

PropertyListHandlerException

_loadPropertyListFromResource

protected void _loadPropertyListFromResource(java.lang.String propertyListName,
                                             java.lang.String propertyListResourcePath)
                                      throws PropertyListHandlerException

This method is used to retrieve a PropertyList from a classpath resource using the symbolic name specified by the propertyListName argument.

Parameters:

propertyListName - - the name of the PropertyList

propertyListResourcePath - - the classloader path of the PropertyList file

Throws:

PropertyListHandlerException

_reloadOnFileChange

protected void _reloadOnFileChange()

This method reloads a file-based XML document based on file change.

_reloadOnFileChange

protected void _reloadOnFileChange(java.lang.String propertyListName)

This method reloads a file-based XML document based on file change.

Parameters:

propertyListName - - the name of the PropertyList

_setFeature

protected void _setFeature(java.lang.String name,
                           boolean value)
                    throws PropertyListHandlerException

This method sets Habitat4J features.

Parameters:

name - - the name of the feature

value - - the boolean value of the feature

Throws:

PropertyListHandlerException

_setFeature

protected void _setFeature(java.lang.String name,
                           int value)
                    throws PropertyListHandlerException

This method sets Habitat4J features.

Parameters:

name - - the name of the feature

value - - the int value of the feature

Throws:

PropertyListHandlerException

_setFeature

protected void _setFeature(java.lang.String name,
                           java.lang.String value)
                    throws PropertyListHandlerException

This method sets Habitat4J features.

Parameters:

name - - the name of the feature

value - - the value of the feature

Throws:

PropertyListHandlerException

_toDisplayString

protected java.lang.String _toDisplayString()

This method is used to produce a human-readable list of all PropertyList instances.

Returns:

Returns a ready-for-display/logging dump of all PropertyList instances

_addGlobalDecoderDefinition

protected void _addGlobalDecoderDefinition(java.lang.String id,
                                           java.lang.Object decoderObject)

Parameters:

id -

decoderObject -

_addGlobalDecoderDefinition

protected void _addGlobalDecoderDefinition(java.lang.String id,
                                           java.lang.Class decoderClass)

Parameters:

id -

decoderClass -

_addGlobalDecryptorDefinition

protected void _addGlobalDecryptorDefinition(java.lang.String id,
                                             java.lang.Object decryptorObject)

Parameters:

id -

decryptorObject -

_addGlobalDecrytorDefinition

protected void _addGlobalDecrytorDefinition(java.lang.String id,
                                            java.lang.Class decryptorClass)

Parameters:

id -

decryptorClass -

_addGlobalPropertyBeanDefinition

protected void _addGlobalPropertyBeanDefinition(java.lang.String id,
                                                java.lang.Class propertyBeanClass)

Parameters:

id -

propertyBeanClass -

_getGlobalReloadEventHandler

protected java.lang.Object _getGlobalReloadEventHandler()

Returns:

Returns the globalReloadEventHandler.

_setGlobalReloadEventHandler

protected void _setGlobalReloadEventHandler(java.lang.Object globalReloadEventHandler)

Parameters:

globalReloadEventHandler - The globalReloadEventHandler to set.

_setPragmaDefinition

protected void _setPragmaDefinition(java.lang.String name,
                                    java.lang.String value)
                             throws PropertyNotAvailableException

Parameters:

name - - the pragma definition name

value - - the pragma definition value

Throws:

PropertyNotAvailableException

_setPragmaDefinition

protected void _setPragmaDefinition(java.lang.String propertyListName,
                                    java.lang.String name,
                                    java.lang.String value)
                             throws PropertyNotAvailableException

Parameters:

propertyListName - - the PropertyList

name - - the pragma definition name

value - - the pragma definition value

Throws:

PropertyNotAvailableException

checkThatPropertyListExists

protected void checkThatPropertyListExists(java.lang.String propertyListName,
                                           java.lang.String name)
                                    throws PropertyNotAvailableException

Parameters:

propertyListName -

name -

Throws:

PropertyNotAvailableException

checkThatPropertyListExists

protected void checkThatPropertyListExists(java.lang.String propertyListName)
                                    throws PropertyNotAvailableException

Throws:

PropertyNotAvailableException

throwPropertyNotAvailableExceptionBecauseListNotInitialized

protected void throwPropertyNotAvailableExceptionBecauseListNotInitialized(java.lang.String propertyListName,
                                                                           java.lang.String name)
                                                                    throws PropertyNotAvailableException

Parameters:

propertyListName -

name -

Throws:

PropertyNotAvailableException

_inhibitReload

protected void _inhibitReload()

_inhibitReload

protected void _inhibitReload(long expiration)

Parameters:

expiration -

_uninhibitReload

protected void _uninhibitReload()

_clearReloadablePropertyLists

protected void _clearReloadablePropertyLists()

_removeReloadablePropertyList

protected void _removeReloadablePropertyList(java.lang.String propertyListName)

_addReloadablePropertyList

protected void _addReloadablePropertyList(java.lang.String propertyListName)

_isReloadablePropertyList

protected boolean _isReloadablePropertyList(java.lang.String propertyListName)