info.soaj.core.properties
Class SjPluginProperties

java.lang.Object
  info.soaj.core.properties.SjPluginProperties

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

SjPropertiesForSystemOutLogging

public class SjPluginProperties
extends java.lang.Object
implements java.io.Serializable

This immutable object contains property values declared in a descriptor document. Values for active plugins are uniquely traceable using the plugin key.

Copyright (c) 2006 - 2009 by Global Technology Consulting Group, Inc. at gtcGroup.com .

Since:

v. 1.0

Author:

MarvinToll@gtcGroup.com

See Also:

Serialized Form

Field Summary

private static java.lang.String	CLASS_NAME Class name.
protected java.util.Properties	pluginAbstractProperties The abstract plugin properties.
protected boolean	pluginActive The plugin status.
protected SjPopulatedPluginClassName	pluginClassName The name of the plugin class.
protected java.util.Properties	pluginConcreteProperties The concrete plugin properties.
protected SjPopulatedPluginCreate	pluginCreate The declared creation technique for a plugin.
protected SjPopulatedPluginKey	pluginKey The key used for unique identification.
protected java.util.Properties	pluginProperties The combined plugin properties.
private static long	serialVersionUID UID

Constructor Summary

SjPluginProperties(java.lang.String pluginKey, boolean pluginActive, java.lang.String pluginCreate, java.lang.String pluginClassName, java.util.Properties pluginAbstractProperties, java.util.Properties pluginConcreteProperties)
Constructor

Method Summary

boolean	containsPluginProperties() This method indicates whether plugin properties are defined.
boolean	containsPropertyKey(java.lang.String propertyKey) This method is a convenience search for the property with the specified key in this property list.
boolean	containsPropertyKey(java.lang.String propertyKey, boolean suppressNullValueCheck) This method is a convenience search for a property with the specified key.
boolean	containsPropertyValue(java.lang.String propertyValue) This method returns true if one or more properties exist with this value.
boolean	containsPropertyValue(java.lang.String propertyValue, java.lang.String propertyKey) This method returns true if a property value exists for the property key specified.
boolean	containsPropertyValueBoolean(java.lang.String propertyKey) This method returns true if a property value exists for the property key specified.
boolean	containsPropertyValueNull(java.lang.String propertyKey) This method returns true if the specified property has a declared value of "null".
java.util.Properties	getPluginAbstractProperties() This method returns the pluginAbstractProperties attribute.
SjPopulatedPluginClassName	getPluginClassName() This method returns the pluginClassName attribute.
java.util.Properties	getPluginConcreteProperties() This method returns the pluginConcreteProperties attribute.
SjPopulatedPluginCreate	getPluginCreate() This method returns the pluginCreate attribute.
SjPopulatedPluginKey	getPluginKey() This method returns the pluginKey attribute.
java.util.Properties	getPluginProperties() This method returns combined plugin properties or null.
java.lang.String[]	getPropertyArray(java.lang.String propertyKey) This method conveniently parses the property.
boolean	getPropertyBoolean(java.lang.String propertyKey) This method conveniently returns a boolean.
int	getPropertyInt(java.lang.String propertyKey) This method conveniently returns a boolean.
java.lang.String	getPropertyValue(java.lang.String propertyKey) This method returns the property value for the specified key.
boolean	isPluginActive() This method returns the pluginActive attribute.
boolean	isPluginAlwaysInstantiated() This method indicates a declared mode for plugin creation.
boolean	isPluginCached() This method indicates a declared mode for plugin creation.

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

UID

See Also:

Constant Field Values

CLASS_NAME

private static final java.lang.String CLASS_NAME

Class name.

pluginKey

protected final SjPopulatedPluginKey pluginKey

The key used for unique identification.

pluginActive

protected final boolean pluginActive

The plugin status.

pluginCreate

protected final SjPopulatedPluginCreate pluginCreate

The declared creation technique for a plugin.

pluginClassName

protected final SjPopulatedPluginClassName pluginClassName

The name of the plugin class.

pluginProperties

protected final java.util.Properties pluginProperties

The combined plugin properties.

pluginAbstractProperties

protected final java.util.Properties pluginAbstractProperties

The abstract plugin properties.

pluginConcreteProperties

protected final java.util.Properties pluginConcreteProperties

The concrete plugin properties.

Constructor Detail

SjPluginProperties

public SjPluginProperties(java.lang.String pluginKey,
                          boolean pluginActive,
                          java.lang.String pluginCreate,
                          java.lang.String pluginClassName,
                          java.util.Properties pluginAbstractProperties,
                          java.util.Properties pluginConcreteProperties)

Constructor

Parameters:

pluginKey -

pluginActive -

pluginCreate -

pluginClassName -

pluginAbstractProperties - May be null

pluginConcreteProperties - May be null.

Method Detail

getPluginKey

public SjPopulatedPluginKey getPluginKey()

This method returns the pluginKey attribute.

Returns:

SjPopulatedPluginKey - A class-scoped attribute.

isPluginActive

public boolean isPluginActive()

This method returns the pluginActive attribute.

Returns:

boolean - A class-scoped attribute.

getPluginCreate

public SjPopulatedPluginCreate getPluginCreate()

This method returns the pluginCreate attribute.

Returns:

SjPopulatedPluginCreate - A class-scoped attribute.

getPluginClassName

public SjPopulatedPluginClassName getPluginClassName()

This method returns the pluginClassName attribute.

Returns:

SjPopulatedPluginClassName - A class-scoped attribute.

getPluginProperties

public java.util.Properties getPluginProperties()
                                         throws SjCoreExceptionFindingProperties

This method returns combined plugin properties or null.

Returns:

Properties - Returns the combined pluginProperties or null.

Throws:

SjCoreExceptionFindingProperties

getPluginAbstractProperties

public java.util.Properties getPluginAbstractProperties()

This method returns the pluginAbstractProperties attribute.

Returns:

Properties - A class-scoped attribute.

getPluginConcreteProperties

public java.util.Properties getPluginConcreteProperties()

This method returns the pluginConcreteProperties attribute.

Returns:

Properties - A class-scoped attribute.

isPluginAlwaysInstantiated

public boolean isPluginAlwaysInstantiated()

This method indicates a declared mode for plugin creation.

Returns:

boolean

isPluginCached

public boolean isPluginCached()

This method indicates a declared mode for plugin creation.

Returns:

boolean

containsPluginProperties

public boolean containsPluginProperties()

This method indicates whether plugin properties are defined.

Returns:

boolean - Whether or not plugin properties are defined.

containsPropertyKey

public boolean containsPropertyKey(java.lang.String propertyKey)

This method is a convenience search for the property with the specified key in this property list. A boolean indicates whether the property is in the list.

Parameters:

propertyKey - The property key.

Returns:

boolean - Whether the property is found.

containsPropertyKey

public boolean containsPropertyKey(java.lang.String propertyKey,
                                   boolean suppressNullValueCheck)

This method is a convenience search for a property with the specified key. A boolean indicates whether the property is in the list. This overloaded version may also check whether the value is "null".

Parameters:

propertyKey - The property key.

suppressNullValueCheck -

Returns:

boolean - Whether the property is found.

containsPropertyValue

public boolean containsPropertyValue(java.lang.String propertyValue)

This method returns true if one or more properties exist with this value.

Parameters:

propertyValue - The property value.

Returns:

boolean - Whether the property value is found.

containsPropertyValue

public boolean containsPropertyValue(java.lang.String propertyValue,
                                     java.lang.String propertyKey)

This method returns true if a property value exists for the property key specified. The property may have the value of "null" or be null.

Parameters:

propertyValue - The property value.

propertyKey - The property key.

Returns:

boolean - Whether the property is found.

containsPropertyValueBoolean

public boolean containsPropertyValueBoolean(java.lang.String propertyKey)

This method returns true if a property value exists for the property key specified. The property may have the value of "true" or "false"

Parameters:

propertyKey - The property key.

Returns:

boolean - Whether the property is found.

containsPropertyValueNull

public boolean containsPropertyValueNull(java.lang.String propertyKey)

This method returns true if the specified property has a declared value of "null".

Parameters:

propertyKey - The property key.

Returns:

boolean - Whether the property value is "null".

getPropertyValue

public java.lang.String getPropertyValue(java.lang.String propertyKey)

This method returns the property value for the specified key. If the key is not found in the property list a null (object) is returned.

Parameters:

propertyKey - The property key.

Returns:

String - The value of the specified property or a null object.

getPropertyArray

public java.lang.String[] getPropertyArray(java.lang.String propertyKey)

This method conveniently parses the property.

Parameters:

propertyKey - The property key.

Returns:

StringNotNull[] - The values in this property list with the specified key.

getPropertyBoolean

public boolean getPropertyBoolean(java.lang.String propertyKey)
                           throws SjCoreExceptionFindingProperties

This method conveniently returns a boolean.

Parameters:

propertyKey - The property key.

Returns:

boolean - The value of the property.

Throws:

SjCoreExceptionFindingProperties

getPropertyInt

public int getPropertyInt(java.lang.String propertyKey)
                   throws SjCoreExceptionFindingProperties

This method conveniently returns a boolean.

Parameters:

propertyKey - The property key.

Returns:

boolean - The value in this property list with the specified key.

Throws:

SjCoreExceptionFindingProperties