Package org.jjazz.phrasetransform.api

Class PtProperties

java.lang.Object

java.util.Dictionary<K,V>

java.util.Hashtable<Object,Object>

java.util.Properties

org.jjazz.phrasetransform.api.PtProperties

All Implemented Interfaces:

Serializable, Cloneable, Map<Object,Object>

public class PtProperties
extends Properties

Special properties for PhraseTransformer.

Supported property keys are defined at construction, and they must all have a default value defined.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROP_PROPERTY

Constructor Summary

Constructors

Constructor	Description
PtProperties(Properties defaultProperties)	Create a properties object.

Method Summary

Modifier and Type	Method	Description
void	addPropertyChangeListener(PropertyChangeListener listener)
PtProperties	getCopy()
List<String>	getNonDefaultValueProperties()	The list of properties for which a non-default value is used.
Boolean	getPropertyAsBoolean(String key)
Float	getPropertyAsFloat(String key)
Integer	getPropertyAsInteger(String key)
void	removePropertyChangeListener(PropertyChangeListener listener)
String	saveAsString(List<String> keys)	Save key/value pairs as a string.
void	setPropertiesFromString(String s)	Set some properties from a saved string.
void	setProperty(String key, Boolean value)
void	setProperty(String key, Float value)
void	setProperty(String key, Integer value)
Object	setProperty(String key, String value)	Overridden to allow setting a value only for a supported key.

Methods inherited from class java.util.Properties

clear, clone, compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, entrySet, equals, forEach, get, getOrDefault, getProperty, getProperty, hashCode, isEmpty, keys, keySet, list, list, load, load, loadFromXML, merge, propertyNames, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, save, size, store, store, storeToXML, storeToXML, storeToXML, stringPropertyNames, toString, values

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Details

PROP_PROPERTY

public static final String PROP_PROPERTY

See Also:

• Constant Field Values

Constructor Details

PtProperties

public PtProperties(Properties defaultProperties)

Create a properties object.

Parameters:

defaultProperties - The supported keys and their default values.

Method Details

getCopy

public PtProperties getCopy()

setProperty

public Object setProperty(String key,
 String value)
                   throws IllegalArgumentException

Overridden to allow setting a value only for a supported key.

Overrides:

setProperty in class Properties

Parameters:

key - Character '=' is forbidden

value - Character '=' is forbidden

Returns:

Throws:

IllegalArgumentException - If key is not supported, or if an illegal character was used

getNonDefaultValueProperties

public List<String> getNonDefaultValueProperties()

The list of properties for which a non-default value is used.

Returns:

getPropertyAsInteger

public Integer getPropertyAsInteger(String key)

getPropertyAsBoolean

public Boolean getPropertyAsBoolean(String key)

getPropertyAsFloat

public Float getPropertyAsFloat(String key)

setProperty

public void setProperty(String key,
 Integer value)

setProperty

public void setProperty(String key,
 Boolean value)

setProperty

public void setProperty(String key,
 Float value)

saveAsString

public String saveAsString(List<String> keys)

Save key/value pairs as a string.

Example: "key1=value1,key2=value2"

Parameters:

keys -

Returns:

See Also:

• setPropertiesFromString(java.lang.String)

setPropertiesFromString

public void setPropertiesFromString(String s)
                             throws ParseException

Set some properties from a saved string.

Parameters:

s -

Throws:

ParseException

See Also:

• saveAsString(java.util.List)

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)