com.highqsoft.interfaces.fwk

Interface FwkPropertyGroupInterface

All Superinterfaces:

java.awt.datatransfer.ClipboardOwner, java.lang.Cloneable, FwkDescriptionInterface, FwkDOMHandlerInterface, FwkInterface, FwkTransferableInterface, java.util.Map<java.lang.Object,java.lang.Object>, java.io.Serializable, java.awt.datatransfer.Transferable

All Known Implementing Classes:

FwkPropertyGroup

public interface FwkPropertyGroupInterface
extends java.util.Map<java.lang.Object,java.lang.Object>, java.lang.Cloneable, FwkInterface, FwkDOMHandlerInterface

This interface defines the basic functionality that a FwkPropertyGroup must implement.

Since:

$Date: 2017/04/06 13:29:11 $

Version:

$Revision: 1.12 $

Author:

Andreas Hofmann

See Also:

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields inherited from interface com.highqsoft.interfaces.fwk.FwkDescriptionInterface

AUTHOR, BUILDNR, COMPANY, COPYRIGHT, DATE_FORMAT, DEFAULT_ICON, DESCRIPTION, INTERNET, LARGE_ICON, LARGE_KEY_EXT, LARGE_OPAQUE_ICON, LARGE_OPAQUE_KEY_EXT, OPAQUE_ICON, OPAQUE_KEY_EXT, RCS_DATE_FORMAT, SUPPORT_EMAIL, TITLE_NAME

Method Summary

Methods

Modifier and Type	Method and Description
FwkPropertyGroupInterface	addGroup(java.lang.String name, FwkPropertyGroupInterface newGroup) Add a property group.
java.lang.Object	clone() Clone the object.
FwkPropertyGroupInterface	getGroup(java.lang.String name) Get a group.
java.lang.String	getProperty(java.lang.String key) Get the property with the requested name.
boolean	getProperty(java.lang.String key, boolean dflt) Get the property.
byte	getProperty(java.lang.String key, byte dflt) Get the property.
char	getProperty(java.lang.String key, char dflt) Get the property.
double	getProperty(java.lang.String key, double dflt) Get the property.
float	getProperty(java.lang.String key, float dflt) Get the property.
int	getProperty(java.lang.String key, int dflt) Get the property.
long	getProperty(java.lang.String key, long dflt) Get the property.
java.lang.Object	getProperty(java.lang.String key, java.lang.Object dflt) Get the property.
short	getProperty(java.lang.String key, short dflt) Get the property.
java.lang.String	getProperty(java.lang.String groupKey, java.lang.String defaultValue) Get the property with the requested name.
boolean	getProperty(java.lang.String group, java.lang.String propertyName, boolean propertyDefault) Get a property with default.
byte	getProperty(java.lang.String group, java.lang.String propertyName, byte propertyDefault) Get a property with default.
char	getProperty(java.lang.String group, java.lang.String propertyName, char propertyDefault) Get a property with default.
java.lang.Object	getProperty(java.lang.String group, java.lang.String propertyName, java.awt.datatransfer.DataFlavor flavor) Get the property with the requested name.
double	getProperty(java.lang.String group, java.lang.String propertyName, double propertyDefault) Get a property with default.
float	getProperty(java.lang.String group, java.lang.String propertyName, float propertyDefault) Get a property with default.
int	getProperty(java.lang.String group, java.lang.String propertyName, int propertyDefault) Get a property with default.
long	getProperty(java.lang.String group, java.lang.String propertyName, long propertyDefault) Get a property with default.
java.lang.Object	getProperty(java.lang.String group, java.lang.String propertyName, java.lang.Object propertyDefault) Get a property with default.
short	getProperty(java.lang.String group, java.lang.String propertyName, short propertyDefault) Get a property with default.
java.lang.String	getProperty(java.lang.String group, java.lang.String propertyName, java.lang.String propertyDefault) Get a property with default.
FwkPropertyGroupInterface	getPropertyGroup(java.lang.String name) Get a property group.
java.util.Enumeration	groupNames() Return an enumeration of the group names.
void	list(java.io.PrintStream out) Prints this property list out to the specified output stream.
void	list(java.io.PrintWriter out) Prints this property list out to the specified output stream.
void	list(java.io.PrintWriter out, java.lang.String prefix) Prints this property list out to the specified output stream.
boolean	load(java.lang.String resource) Load the property group from file or resource.
java.util.Enumeration	propertyNames() Return en enumeration of the property names.
FwkPropertyGroupInterface	removeGroup(java.lang.String name) Remove a property group.
boolean	save(java.lang.String resource) Save the property group from file or resource.
java.lang.Object	setProperty(java.lang.String key, boolean value) Set a property value.
java.lang.Object	setProperty(java.lang.String key, byte value) Set a property value.
java.lang.Object	setProperty(java.lang.String key, char value) Set a property value.
java.lang.Object	setProperty(java.lang.String key, double value) Set a property value.
java.lang.Object	setProperty(java.lang.String key, float value) Set a property value.
java.lang.Object	setProperty(java.lang.String key, int value) Set a property value.
java.lang.Object	setProperty(java.lang.String key, long value) Set a property value.
java.lang.Object	setProperty(java.lang.String key, short value) Set a property value.
java.lang.Object	setProperty(java.lang.String key, java.lang.String value) Set a property value.
java.lang.Object	setProperty(java.lang.String groupKey, java.lang.String key, boolean value) Set a property value.
java.lang.Object	setProperty(java.lang.String groupKey, java.lang.String key, byte value) Set a property value.
java.lang.Object	setProperty(java.lang.String groupKey, java.lang.String key, char value) Set a property value.
java.lang.Object	setProperty(java.lang.String groupKey, java.lang.String key, double value) Set a property value.
java.lang.Object	setProperty(java.lang.String groupKey, java.lang.String key, float value) Set a property value.
java.lang.Object	setProperty(java.lang.String groupKey, java.lang.String key, int value) Set a property value.
java.lang.Object	setProperty(java.lang.String groupKey, java.lang.String key, long value) Set a property value.
java.lang.Object	setProperty(java.lang.String groupKey, java.lang.String key, short value) Set a property value.
java.lang.Object	setProperty(java.lang.String groupKey, java.lang.String key, java.lang.String value) Set a property value.

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkDOMHandlerInterface

getCompany, readConstructor, readFromDOM, readingDOM, readingDOM, writeConstructor, writeToDOM, writeToXML

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkDescriptionInterface

getAuthor, getBuild, getClassName, getCompanyInternetAddress, getCopyright, getCreationDate, getCreationDate, getDateFormatString, getDescription, getIcon, getIcon, getIconKey, getIconKey, getName, getPresentationString, getPresentationString, getSupportEMail, getTitle, getTitleName, setAuthor, setBuild, setClassName, setCompany, setCompanyInternetAddress, setCopyright, setCreationDate, setCreationDate, setDateFormatString, setDescription, setDescriptor, setIcon, setIcon, setIconKey, setIconKey, setName, setSupportEMail, setTitleName

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInterface

getVersion, release

Methods inherited from interface java.awt.datatransfer.Transferable

getTransferData, getTransferDataFlavors, isDataFlavorSupported

Methods inherited from interface java.awt.datatransfer.ClipboardOwner

lostOwnership

Method Detail

getProperty

java.lang.Object getProperty(java.lang.String group,
                           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

java.lang.String getProperty(java.lang.String groupKey,
                           java.lang.String defaultValue)

Get the property with the requested name.
The first of all the method tries to get the group and return the property of the group. If the group or the property is not available the method tries to seperate a group key from the first parameter assuming that the group key is separated by a dot. Then it tries to get the the property by calling the mehtod getProperty(groupName, propKey, defaultValue) where the defaultValue is the second parameter of this call.

Parameters:

groupKey - The name of the group.

defaultValue - The requested property name.

Returns:

The requested property.

getProperty

java.lang.Object getProperty(java.lang.String key,
                           java.lang.Object dflt)

Get the property.

Parameters:

key - The name of the property. The group name must be separated by a dot from group property name.

dflt - The default value.

Returns:

The requested property.

getProperty

boolean getProperty(java.lang.String key,
                  boolean dflt)

Get the property.

Parameters:

key - The name of the property. The group name must be separated by a dot from group property name.

dflt - The default value.

Returns:

The requested property.

getProperty

int getProperty(java.lang.String key,
              int dflt)

Get the property.

Parameters:

key - The name of the group.

dflt - The default value.

Returns:

The requested property.

getProperty

short getProperty(java.lang.String key,
                short dflt)

Get the property.

Parameters:

key - The name of the property. The group name must be separated by a dot from group property name.

dflt - The default value.

Returns:

The requested property.

getProperty

byte getProperty(java.lang.String key,
               byte dflt)

Get the property.

Parameters:

key - The name of the property. The group name must be separated by a dot from group property name.

dflt - The default value.

Returns:

The requested property.

getProperty

char getProperty(java.lang.String key,
               char dflt)

Get the property.

Parameters:

key - The name of the property. The group name must be separated by a dot from group property name.

dflt - The default value.

Returns:

The requested property.

getProperty

long getProperty(java.lang.String key,
               long dflt)

Get the property.

Parameters:

key - The name of the property. The group name must be separated by a dot from group property name.

dflt - The default value.

Returns:

The requested property.

getProperty

float getProperty(java.lang.String key,
                float dflt)

Get the property.

Parameters:

key - The name of the property. The group name must be separated by a dot from group property name.

dflt - The default value.

Returns:

The requested property.

getProperty

double getProperty(java.lang.String key,
                 double dflt)

Get the property.

Parameters:

key - The name of the property. The group name must be separated by a dot from group property name.

dflt - The default value.

Returns:

The requested property.

getProperty

java.lang.String getProperty(java.lang.String key)

Get the property with the requested name.

Parameters:

propertyName - The requested property name.

Returns:

The requested property.

setProperty

java.lang.Object setProperty(java.lang.String key,
                           java.lang.String value)

Set a property value.

Parameters:

key - - the key to be placed into this property list.

value - - the value corresponding to key.

setProperty

java.lang.Object setProperty(java.lang.String key,
                           boolean value)

Set a property value.

Parameters:

key - - the key to be placed into this property list.

value - - the value corresponding to key.

setProperty

java.lang.Object setProperty(java.lang.String key,
                           int value)

Set a property value.

Parameters:

key - - the key to be placed into this property list.

value - - the value corresponding to key.

setProperty

java.lang.Object setProperty(java.lang.String key,
                           short value)

Set a property value.

Parameters:

key - - the key to be placed into this property list.

value - - the value corresponding to key.

setProperty

java.lang.Object setProperty(java.lang.String key,
                           byte value)

Set a property value.

Parameters:

key - - the key to be placed into this property list.

value - - the value corresponding to key.

setProperty

java.lang.Object setProperty(java.lang.String key,
                           char value)

Set a property value.

Parameters:

key - - the key to be placed into this property list.

value - - the value corresponding to key.

setProperty

java.lang.Object setProperty(java.lang.String key,
                           long value)

Set a property value.

Parameters:

key - - the key to be placed into this property list.

value - - the value corresponding to key.

setProperty

java.lang.Object setProperty(java.lang.String key,
                           float value)

Set a property value.

Parameters:

key - - the key to be placed into this property list.

value - - the value corresponding to key.

setProperty

java.lang.Object setProperty(java.lang.String key,
                           double value)

Set a property value.

Parameters:

key - - the key to be placed into this property list.

value - - the value corresponding to key.

setProperty

java.lang.Object setProperty(java.lang.String groupKey,
                           java.lang.String key,
                           java.lang.String value)

Set a property value.

Parameters:

groupKey - - The name of the group.

key - - the key to be placed into this property list.

value - - the value corresponding to key.

setProperty

java.lang.Object setProperty(java.lang.String groupKey,
                           java.lang.String key,
                           boolean value)

Set a property value.

Parameters:

groupKey - - The name of the group.

key - - the key to be placed into this property list.

value - - the value corresponding to key.

setProperty

java.lang.Object setProperty(java.lang.String groupKey,
                           java.lang.String key,
                           int value)

Set a property value.

Parameters:

groupKey - - The name of the group.

key - - the key to be placed into this property list.

value - - the value corresponding to key.

setProperty

java.lang.Object setProperty(java.lang.String groupKey,
                           java.lang.String key,
                           short value)

Set a property value.

Parameters:

groupKey - - The name of the group.

key - - the key to be placed into this property list.

value - - the value corresponding to key.

setProperty

java.lang.Object setProperty(java.lang.String groupKey,
                           java.lang.String key,
                           byte value)

Set a property value.

Parameters:

groupKey - - The name of the group.

key - - the key to be placed into this property list.

value - - the value corresponding to key.

setProperty

java.lang.Object setProperty(java.lang.String groupKey,
                           java.lang.String key,
                           char value)

Set a property value.

Parameters:

groupKey - - The name of the group.

key - - the key to be placed into this property list.

value - - the value corresponding to key.

setProperty

java.lang.Object setProperty(java.lang.String groupKey,
                           java.lang.String key,
                           long value)

Set a property value.

Parameters:

groupKey - - The name of the group.

key - - the key to be placed into this property list.

value - - the value corresponding to key.

setProperty

java.lang.Object setProperty(java.lang.String groupKey,
                           java.lang.String key,
                           float value)

Set a property value.

Parameters:

groupKey - - The name of the group.

key - - the key to be placed into this property list.

value - - the value corresponding to key.

setProperty

java.lang.Object setProperty(java.lang.String groupKey,
                           java.lang.String key,
                           double value)

Set a property value.

Parameters:

groupKey - - The name of the group.

key - - the key to be placed into this property list.

value - - the value corresponding to key.

getProperty

boolean getProperty(java.lang.String group,
                  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:

group - The name of the group.

propertyName - The name of the property.

propertyDefault - The default property.

Returns:

The requested property or it's default.

getProperty

int getProperty(java.lang.String group,
              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:

group - The name of the group.

propertyName - The name of the property.

propertyDefault - The default property.

Returns:

The requested property or it's default.

getProperty

short getProperty(java.lang.String group,
                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:

group - The name of the group.

propertyName - The name of the property.

propertyDefault - The default property.

Returns:

The requested property or it's default.

getProperty

byte getProperty(java.lang.String group,
               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:

group - The name of the group.

propertyName - The name of the property.

propertyDefault - The default property.

Returns:

The requested property or it's default.

getProperty

char getProperty(java.lang.String group,
               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:

group - The name of the group.

propertyName - The name of the property.

propertyDefault - The default property.

Returns:

The requested property or it's default.

getProperty

long getProperty(java.lang.String group,
               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:

group - The name of the group.

propertyName - The name of the property.

propertyDefault - The default property.

Returns:

The requested property or it's default.

getProperty

float getProperty(java.lang.String group,
                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:

group - The name of the group.

propertyName - The name of the property.

propertyDefault - The default property.

Returns:

The requested property or it's default.

getProperty

double getProperty(java.lang.String group,
                 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:

group - The name of the group.

propertyName - The name of the property.

propertyDefault - The default property.

Returns:

The requested property or it's default.

getProperty

java.lang.String getProperty(java.lang.String group,
                           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:

group - The name of the group.

propertyName - The name of the property.

propertyDefault - The default property.

Returns:

The requested property or it's default.

getProperty

java.lang.Object getProperty(java.lang.String group,
                           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:

group - The name of the group.

propertyName - The name of the property.

propertyDefault - The default property.

Returns:

The requested property or it's default.

getPropertyGroup

FwkPropertyGroupInterface getPropertyGroup(java.lang.String name)

Get a property group.

Parameters:

name - the name of the property group.

Returns:

the requested group or null

addGroup

FwkPropertyGroupInterface addGroup(java.lang.String name,
                                 FwkPropertyGroupInterface newGroup)

Add a property group.

Parameters:

name - the name of the property group.

newGroup - The group to be added.

Returns:

the newly created or expanded group or null if not possible.

removeGroup

FwkPropertyGroupInterface removeGroup(java.lang.String name)

Remove a property group.

Parameters:

name - the name of the property group.

Returns:

the removed group or null if not found

list

void list(java.io.PrintStream out)

Prints this property list out to the specified output stream. This method is useful for debugging.

Parameters:

out - an output stream.

list

void list(java.io.PrintWriter out)

Prints this property list out to the specified output stream. This method is useful for debugging.

Parameters:

out - an output stream.

list

void list(java.io.PrintWriter out,
        java.lang.String prefix)

Prints this property list out to the specified output stream. This method is useful for debugging.

Parameters:

out - an output stream.

prefix - a line prefix for output.

groupNames

java.util.Enumeration groupNames()

Return an enumeration of the group names.

Returns:

the enumeration.

propertyNames

java.util.Enumeration propertyNames()

Return en enumeration of the property names.

Returns:

the enumeration.

getGroup

FwkPropertyGroupInterface getGroup(java.lang.String name)

Get a group.

Parameters:

name - the name of the group.

Returns:

the group or null

clone

java.lang.Object clone()

Clone the object.

load

boolean load(java.lang.String resource)

Load the property group from file or resource.

Parameters:

resource - The resource or filename.

Returns:

true if successful.

save

boolean save(java.lang.String resource)

Save the property group from file or resource.

Parameters:

resource - The resource or filename.

Returns:

true if successful.