com.highqsoft.fwk

Class FwkPropertyBus

java.lang.Object

com.highqsoft.fwk.FwkPropertyBus

All Implemented Interfaces:

FwkPropertyBusInterface, java.io.Serializable

public class FwkPropertyBus
extends java.lang.Object
implements java.io.Serializable, FwkPropertyBusInterface

The FWK Property Bus object provides an easy-to-use access to the property bus.

Since:

$Date: 2017/04/28 08:47:41 $

Version:

$Revision: 1.16 $

Author:

HighQSoft GmbH

See Also:

, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.awt.datatransfer.DataFlavor	BOOLEAN Mnemonics for the java.lang.Boolean mime type.
protected static java.awt.datatransfer.DataFlavor	BOOLEAN_FLAVOR
protected static int	BOOLEAN_INDEX
static java.lang.String	BUSDEFAULTNAME FWK property bus default name.
static java.lang.String	BUSNAME FWK property bus name.
static java.lang.String	BUSNAMEKEY FWK property bus key.
static java.awt.datatransfer.DataFlavor	BYTE Mnemonics for the java.lang.Byte mime type.
protected static java.awt.datatransfer.DataFlavor	BYTE_FLAVOR
protected static int	BYTE_INDEX
static java.awt.datatransfer.DataFlavor	CHARACTER Mnemonics for the java.lang.Character mime type.
protected static java.awt.datatransfer.DataFlavor	CHARACTER_FLAVOR
protected static int	CHARACTER_INDEX
static java.awt.datatransfer.DataFlavor[]	DATAFLAVORS The data flavor list.
static java.awt.datatransfer.DataFlavor	DOUBLE Mnemonics for the java.lang.Float mime type.
protected static java.awt.datatransfer.DataFlavor	DOUBLE_FLAVOR
protected static int	DOUBLE_INDEX
protected static java.awt.datatransfer.DataFlavor[]	flavors
static java.awt.datatransfer.DataFlavor	FLOAT Mnemonics for the java.lang.Flaot mime type.
protected static java.awt.datatransfer.DataFlavor	FLOAT_FLAVOR
protected static int	FLOAT_INDEX
static java.awt.datatransfer.DataFlavor	GROUP Mnemonics for the FwkPropertyGroupInterface mime type.
protected static java.awt.datatransfer.DataFlavor	GROUP_FLAVOR
protected static int	GROUP_INDEX
protected static int	INDEX_LENGTH
static java.awt.datatransfer.DataFlavor	INTEGER Mnemonics for the java.lang.Integer mime type.
protected static java.awt.datatransfer.DataFlavor	INTEGER_FLAVOR
protected static int	INTEGER_INDEX
static java.awt.datatransfer.DataFlavor	LONG Mnemonics for the java.lang.Long mime type.
protected static java.awt.datatransfer.DataFlavor	LONG_FLAVOR
protected static int	LONG_INDEX
static java.lang.String[]	MIMETYPES The mime type list.
static java.awt.datatransfer.DataFlavor	OBJECT Mnemonics for the java.lang.Object mime type.
protected static int	OBJECT_INDEX
static java.awt.datatransfer.DataFlavor	SHORT Mnemonics for the java.lang.Short mime type.
protected static java.awt.datatransfer.DataFlavor	SHORT_FLAVOR
protected static int	SHORT_INDEX
static java.awt.datatransfer.DataFlavor	STRING Mnemonics for the java.lang.String mime type.
protected static java.awt.datatransfer.DataFlavor	STRING_FLAVOR
protected static int	STRING_INDEX
static java.lang.String	version

Constructor Summary

Constructors

Constructor and Description
FwkPropertyBus()

Method Summary

Methods

Modifier and Type	Method and Description
static void	addPropery(java.lang.String name, java.lang.Boolean value) Adds a new property to the internal property map.
static void	addPropery(java.lang.String name, java.lang.String value) Adds a new property to the internal property map.
static java.awt.datatransfer.DataFlavor	getBooleanDataFlavor() Retrieves the data flavor for the boolean.
static java.awt.datatransfer.DataFlavor	getByteDataFlavor() Retrieves the data flavor for the byte.
static java.awt.datatransfer.DataFlavor	getCharacterDataFlavor() Retrieves the data flavor for the character.
static java.awt.datatransfer.DataFlavor[]	getDataFlavors() Retrieves an array containing all supported mime data flavors.
static java.awt.datatransfer.DataFlavor	getDoubleDataFlavor() Retrieves the data flavor for the double.
static java.awt.datatransfer.DataFlavor	getFloatDataFlavor() Retrieves the data flavor for the float.
static java.awt.datatransfer.DataFlavor	getGroupDataFlavor() Retrieves the data flavor for the property group.
static java.awt.datatransfer.DataFlavor	getIntegerDataFlavor() Retrieves the data flavor for the integer.
static java.awt.datatransfer.DataFlavor	getLongDataFlavor() Retrieves the data flavor for the long.
static java.awt.datatransfer.DataFlavor	getObjectDataFlavor() Retrieves the data flavor of the object.
static java.util.Map	getProperties() Get the all available properties
static java.lang.String	getProperty(java.lang.String propertyName) Get the property with the requested name.
static boolean	getProperty(java.lang.String propertyName, boolean propertyDefault) Get a property with default.
static byte	getProperty(java.lang.String propertyName, byte propertyDefault) Get a property with default.
static char	getProperty(java.lang.String propertyName, char propertyDefault) Get a property with default.
static java.lang.Object	getProperty(java.lang.String propertyName, java.awt.datatransfer.DataFlavor flavor) Get the property with the requested name.
static double	getProperty(java.lang.String propertyName, double propertyDefault) Get a property with default.
static float	getProperty(java.lang.String propertyName, float propertyDefault) Get a property with default.
static int	getProperty(java.lang.String propertyName, int propertyDefault) Get a property with default.
static long	getProperty(java.lang.String propertyName, long propertyDefault) Get a property with default.
static java.lang.Object	getProperty(java.lang.String propertyName, java.lang.Object propertyDefault) Get a property with default.
static short	getProperty(java.lang.String propertyName, short propertyDefault) Get a property with default.
static java.lang.String	getProperty(java.lang.String propertyName, java.lang.String propertyDefault) Get a property with default.
static FwkPropertyGroupInterface	getPropertyGroup(java.lang.String groupName) Get the property with the requested name.
static java.util.Map	getPropertyGroups() Get the all available properties
static java.awt.datatransfer.DataFlavor	getShortDataFlavor() Retrieves the data flavor for the short.
static java.awt.datatransfer.DataFlavor	getStringDataFlavor() Retrieves the data flavor for the string.
java.lang.String	getVersion()
static void	loadFile(java.lang.String filename) Load the content of the INI file into the property producer.
static void	readUserPropertyFile(java.lang.String className) Read the high priority property filename of the user.
static void	setProperties(java.util.Map map) Set the properties.

Methods inherited from class java.lang.Object

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

Field Detail

version

public static final java.lang.String version

See Also:

Constant Field Values

BUSDEFAULTNAME

public static final java.lang.String BUSDEFAULTNAME

FWK property bus default name.

See Also:

Constant Field Values

BUSNAMEKEY

public static final java.lang.String BUSNAMEKEY

FWK property bus key.

See Also:

Constant Field Values

BUSNAME

public static java.lang.String BUSNAME

FWK property bus name.

MIMETYPES

public static final java.lang.String[] MIMETYPES

The mime type list.

OBJECT_INDEX

protected static final int OBJECT_INDEX

See Also:

Constant Field Values

BOOLEAN_INDEX

protected static final int BOOLEAN_INDEX

See Also:

Constant Field Values

BYTE_INDEX

protected static final int BYTE_INDEX

See Also:

Constant Field Values

CHARACTER_INDEX

protected static final int CHARACTER_INDEX

See Also:

Constant Field Values

DOUBLE_INDEX

protected static final int DOUBLE_INDEX

See Also:

Constant Field Values

FLOAT_INDEX

protected static final int FLOAT_INDEX

See Also:

Constant Field Values

INTEGER_INDEX

protected static final int INTEGER_INDEX

See Also:

Constant Field Values

LONG_INDEX

protected static final int LONG_INDEX

See Also:

Constant Field Values

SHORT_INDEX

protected static final int SHORT_INDEX

See Also:

Constant Field Values

STRING_INDEX

protected static final int STRING_INDEX

See Also:

Constant Field Values

GROUP_INDEX

protected static final int GROUP_INDEX

See Also:

Constant Field Values

INDEX_LENGTH

protected static final int INDEX_LENGTH

See Also:

Constant Field Values

DATAFLAVORS

public static final java.awt.datatransfer.DataFlavor[] DATAFLAVORS

The data flavor list.

OBJECT

public static final java.awt.datatransfer.DataFlavor OBJECT

Mnemonics for the java.lang.Object mime type.

BOOLEAN

public static final java.awt.datatransfer.DataFlavor BOOLEAN

Mnemonics for the java.lang.Boolean mime type.

BYTE

public static final java.awt.datatransfer.DataFlavor BYTE

Mnemonics for the java.lang.Byte mime type.

CHARACTER

public static final java.awt.datatransfer.DataFlavor CHARACTER

Mnemonics for the java.lang.Character mime type.

DOUBLE

public static final java.awt.datatransfer.DataFlavor DOUBLE

Mnemonics for the java.lang.Float mime type.

FLOAT

public static final java.awt.datatransfer.DataFlavor FLOAT

Mnemonics for the java.lang.Flaot mime type.

INTEGER

public static final java.awt.datatransfer.DataFlavor INTEGER

Mnemonics for the java.lang.Integer mime type.

LONG

public static final java.awt.datatransfer.DataFlavor LONG

Mnemonics for the java.lang.Long mime type.

SHORT

public static final java.awt.datatransfer.DataFlavor SHORT

Mnemonics for the java.lang.Short mime type.

STRING

public static final java.awt.datatransfer.DataFlavor STRING

Mnemonics for the java.lang.String mime type.

GROUP

public static final java.awt.datatransfer.DataFlavor GROUP

Mnemonics for the FwkPropertyGroupInterface mime type.

flavors

protected static java.awt.datatransfer.DataFlavor[] flavors

BOOLEAN_FLAVOR

protected static java.awt.datatransfer.DataFlavor BOOLEAN_FLAVOR

BYTE_FLAVOR

protected static java.awt.datatransfer.DataFlavor BYTE_FLAVOR

CHARACTER_FLAVOR

protected static java.awt.datatransfer.DataFlavor CHARACTER_FLAVOR

DOUBLE_FLAVOR

protected static java.awt.datatransfer.DataFlavor DOUBLE_FLAVOR

FLOAT_FLAVOR

protected static java.awt.datatransfer.DataFlavor FLOAT_FLAVOR

INTEGER_FLAVOR

protected static java.awt.datatransfer.DataFlavor INTEGER_FLAVOR

LONG_FLAVOR

protected static java.awt.datatransfer.DataFlavor LONG_FLAVOR

SHORT_FLAVOR

protected static java.awt.datatransfer.DataFlavor SHORT_FLAVOR

STRING_FLAVOR

protected static java.awt.datatransfer.DataFlavor STRING_FLAVOR

GROUP_FLAVOR

protected static java.awt.datatransfer.DataFlavor GROUP_FLAVOR

Constructor Detail

FwkPropertyBus

public FwkPropertyBus()

Method Detail

getVersion

public java.lang.String getVersion()

readUserPropertyFile

public static void readUserPropertyFile(java.lang.String className)

Read the high priority property filename of the user.

Parameters:

className - the name of the class.

setProperties

public static void setProperties(java.util.Map map)

Set the properties. These properties have the highest priority. Before all a request to the infobus will send the object looks into this map to find the requested property.

Parameters:

map - The property map.

addPropery

public static void addPropery(java.lang.String name,
              java.lang.String value)

Adds a new property to the internal property map.

Parameters:

name - Name of the property.

value - Value of type String.

addPropery

public static void addPropery(java.lang.String name,
              java.lang.Boolean value)

Adds a new property to the internal property map.

Parameters:

name - Name of the property.

value - Value of type Boolean.

getProperty

public static java.lang.Object getProperty(java.lang.String propertyName,
                           java.awt.datatransfer.DataFlavor flavor)

Get the property with the requested name.

Parameters:

propertyName - The requested property name.

mimeType - The requested mime type.

Returns:

The requested property.

getProperty

public static java.lang.String getProperty(java.lang.String propertyName)

Get the property with the requested name. Returns the parameter if no property was found.

Parameters:

propertyName - The requested property name.

Returns:

The requested property.

getProperty

public static boolean getProperty(java.lang.String propertyName,
                  boolean propertyDefault)

Get a property with default. If the requested property can not be found on the property bus the default value is returned. This is a convienience function to avoid tedious error checking in the calling method.

Parameters:

propertyName - The name of the property.

propertyDefault - The default property.

Returns:

The requested property or it's default.

getProperty

public static int getProperty(java.lang.String propertyName,
              int propertyDefault)

Get a property with default. If the requested property can not be found on the property bus the default value is returned. This is a convienience function to avoid tedious error checking in the calling method.

Parameters:

propertyName - The name of the property.

propertyDefault - The default property.

Returns:

The requested property or it's default.

getProperty

public static short getProperty(java.lang.String propertyName,
                short propertyDefault)

Get a property with default. If the requested property can not be found on the property bus the default value is returned. This is a convienience function to avoid tedious error checking in the calling method.

Parameters:

propertyName - The name of the property.

propertyDefault - The default property.

Returns:

The requested property or it's default.

getProperty

public static byte getProperty(java.lang.String propertyName,
               byte propertyDefault)

Get a property with default. If the requested property can not be found on the property bus the default value is returned. This is a convienience function to avoid tedious error checking in the calling method.

Parameters:

propertyName - The name of the property.

propertyDefault - The default property.

Returns:

The requested property or it's default.

getProperty

public static char getProperty(java.lang.String propertyName,
               char propertyDefault)

Get a property with default. If the requested property can not be found on the property bus the default value is returned. This is a convienience function to avoid tedious error checking in the calling method.

Parameters:

propertyName - The name of the property.

propertyDefault - The default property.

Returns:

The requested property or it's default.

getProperty

public static long getProperty(java.lang.String propertyName,
               long propertyDefault)

Get a property with default. If the requested property can not be found on the property bus the default value is returned. This is a convienience function to avoid tedious error checking in the calling method.

Parameters:

propertyName - The name of the property.

propertyDefault - The default property.

Returns:

The requested property or it's default.

getProperty

public static float getProperty(java.lang.String propertyName,
                float propertyDefault)

Get a property with default. If the requested property can not be found on the property bus the default value is returned. This is a convienience function to avoid tedious error checking in the calling method.

Parameters:

propertyName - The name of the property.

propertyDefault - The default property.

Returns:

The requested property or it's default.

getProperty

public static double getProperty(java.lang.String propertyName,
                 double propertyDefault)

Get a property with default. If the requested property can not be found on the property bus the default value is returned. This is a convienience function to avoid tedious error checking in the calling method.

Parameters:

propertyName - The name of the property.

propertyDefault - The default property.

Returns:

The requested property or it's default.

getProperty

public static java.lang.String getProperty(java.lang.String propertyName,
                           java.lang.String propertyDefault)

Get a property with default. If the requested property can not be found on the property bus the default value is returned. This is a convienience function to avoid tedious error checking in the calling method.

Parameters:

propertyName - The name of the property.

propertyDefault - The default property.

Returns:

The requested property or it's default.

getProperty

public static java.lang.Object getProperty(java.lang.String propertyName,
                           java.lang.Object propertyDefault)

Get a property with default. If the requested property can not be found on the property bus the default value is returned. This is a convienience function to avoid tedious error checking in the calling method.

Parameters:

propertyName - The name of the property.

propertyDefault - The default property.

Returns:

The requested property or it's default.

getPropertyGroup

public static FwkPropertyGroupInterface getPropertyGroup(java.lang.String groupName)

Get the property with the requested name.

Parameters:

groupName - The requested property name.

Returns:

The requested property group.

getProperties

public static java.util.Map getProperties()

Get the all available properties

Parameters:

propertyName - The requested property name.

Returns:

An object array containing all available property maps.

getPropertyGroups

public static java.util.Map getPropertyGroups()

Get the all available properties

Parameters:

propertyName - The requested property name.

Returns:

An object array containing all available property maps.

loadFile

public static void loadFile(java.lang.String filename)

Load the content of the INI file into the property producer.

Parameters:

filename - The name of the initialization file.

getObjectDataFlavor

public static java.awt.datatransfer.DataFlavor getObjectDataFlavor()

Retrieves the data flavor of the object.

Returns:

The data flavor of the object mimetype.

getBooleanDataFlavor

public static java.awt.datatransfer.DataFlavor getBooleanDataFlavor()

Retrieves the data flavor for the boolean.

Returns:

The data flavor of the boolean mimetype.

getByteDataFlavor

public static java.awt.datatransfer.DataFlavor getByteDataFlavor()

Retrieves the data flavor for the byte.

Returns:

The data flavor of the byte mimetype.

getCharacterDataFlavor

public static java.awt.datatransfer.DataFlavor getCharacterDataFlavor()

Retrieves the data flavor for the character.

Returns:

The data flavor of the character mimetype.

getDoubleDataFlavor

public static java.awt.datatransfer.DataFlavor getDoubleDataFlavor()

Retrieves the data flavor for the double.

Returns:

The data flavor of the double mimetype.

getFloatDataFlavor

public static java.awt.datatransfer.DataFlavor getFloatDataFlavor()

Retrieves the data flavor for the float.

Returns:

The data flavor of the float mimetype.

getIntegerDataFlavor

public static java.awt.datatransfer.DataFlavor getIntegerDataFlavor()

Retrieves the data flavor for the integer.

Returns:

The data flavor of the integer mimetype.

getLongDataFlavor

public static java.awt.datatransfer.DataFlavor getLongDataFlavor()

Retrieves the data flavor for the long.

Returns:

The data flavor of the long mimetype.

getShortDataFlavor

public static java.awt.datatransfer.DataFlavor getShortDataFlavor()

Retrieves the data flavor for the short.

Returns:

The data flavor of the short mimetype.

getStringDataFlavor

public static java.awt.datatransfer.DataFlavor getStringDataFlavor()

Retrieves the data flavor for the string.

Returns:

The data flavor of the string mimetype.

getGroupDataFlavor

public static java.awt.datatransfer.DataFlavor getGroupDataFlavor()

Retrieves the data flavor for the property group.

Returns:

The data flavor of the property group mimetype.

getDataFlavors

public static java.awt.datatransfer.DataFlavor[] getDataFlavors()

Retrieves an array containing all supported mime data flavors.

Returns:

An array of data flavors.