com.iizix.prop

Class StringArrayProp

java.lang.Object

com.iizix.prop.GProp<List<String>>

com.iizix.prop.StringArrayProp

All Implemented Interfaces:

EventListener, IGProp<List<String>>, Cloneable

public class StringArrayProp
extends GProp<List<String>>

The String Array property class holds the property name, string array and optionally has a parent and/or property listener(s). The string array is maintained in a synchronized ArrayList (for synchronization reasons). Access is allowed directly to the ArraList<String> for performance reasons but no events for value-changed for the property is fired, this must be done manually by calling setChanged.

Author:

Christopher Mindus

Field Summary

Fields inherited from class com.iizix.prop.GProp

GPDEBUG, PROP_ATTR_STRING_EDITOR_PROP, PROP_ATTR_STRING_ERRORED_NAME, PROP_ATTR_STRING_EXTENDS, PROP_ATTR_STRING_EXTENDS_FINAL, PROP_ATTR_STRING_EXTENDS_PRIVATE, PROP_ATTR_STRING_NULLABLE, PROP_ATTR_STRING_PRIVATE, PROP_ATTR_STRING_PRIVATE_CHANGE_EVENT, PROP_ATTR_STRING_READ_ONLY, PROP_USER_1, PROP_USER_2

Fields inherited from interface com.iizix.prop.IGProp

EQC_ERROR_IGNORE_ALL, EQC_ERROR_IGNORE_REFERENCES, EQC_IGNORE_ARRAY, EQC_IGNORE_VOLATILE_OR_EDITOR, EQC_PRIVATE, EQC_SAVE_FILE, EXT_CONTAINER_EXTENDS, EXT_CONTAINER_EXTENDS_VALID, EXT_EXTENDED, EXT_FINAL, EXT_OVERRIDES, EXT_OVERRIDES_FINAL_ERR, EXT_PRIVATE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StringArrayProp() Creates an string array with no name and an empty synchronized ArrayList<String> array.
	StringArrayProp(Atom propertyAtom) Creates an string array property with the specified name with an empty synchronized ArrayList<String> array.
	StringArrayProp(Atom propertyAtom, List<String> newValue) Creates an string array property with the specified name with an empty synchronized ArrayList<String> array initialized with the specified strings.

Method Summary

Modifier and Type	Method and Description
void	addString(String s) Adds a string to the array.
void	addString(String s, int index) Adds (inserts) a string at the requested index in the array.
void	addStrings(List<String> newStringList) Adds all strings from a list.
void	addStrings(String[] strings) Adds all strings from a string array.
protected void	appendPropValue(PropMgr propertyManager, Transaction trans, Object value) Appends the string array to an outgoing transaction.
boolean	clear() Removes all strings from the array.
StringArrayProp	clone() Creates a clone out of this property.
static StringArrayProp	createUnmodifiableReadOnly(Atom atom, String[] strings) Creates a new StringArrayProp from a predefined array of strings that is placed in an unmodifiable list.
List<String>	getArrayList() Gets the synchronized ArrayList<String> of all strings.
protected Object	getPropValue0(Object value, int index) Gets the property value in another class form than the "native" one.
String	getString(int index) Gets a string from a specific index in the array.
Class<?>[]	getValueClasses() Gets the list of possible native Java classes that can be used to set a value using setPropertyValue, in order of importance.
void	initializeElement(Element element) Called when the XML file for the property tree is serialized from properties.
void	initializeProp(Element element) Called to initialize the property from an Element.
boolean	initializeValue(PropMgr propertyManager, Transaction trans) Initializes the property value from a transaction.
protected int	modifyPropValue(Object oldValue, Object newValue, PropMgr propMgr) Called when setting a new value for this property.
String	removeString(int index) Removes a string in the at a specific index.
boolean	removeString(String s) Removes the request string from the array.
String	setString(String s, int index) Sets a string at a specific index in the array.
int	size() Gets the string count in the array.
void	sortList() Sorts the list according to the default JVM locale.
void	sortList(boolean isCaseInsensitive) Sorts the list according to the default JVM locale.
void	sortList(Locale locale) Sorts the list according to a locale.
void	sortList(Locale locale, boolean isCaseInsensitive) Sorts the list according to a locale.
protected Object	toNativeValue0(Object value, int index) Tries conversion of possibly accepted properties values using the setPropertyValue method into the most preferred property value type.
void	validatePropType(Object newValue) Validates that the value to set is of List<?> instance.

Methods inherited from class com.iizix.prop.GProp

addPropError, addPropListener, convertPropError, dispose, equals, equals, equalsErrors, equalsObj, equalsPropValue, equalsTree, equalValues, extendsClone, finalize, fine, fine, finer, finer, finest, finest, fromElementString, getAliasName, getAppSessionGyro, getAppWorker, getAtomPath, getAttribute, getChildReferencePropName, getClientSessionGyro, getClientWorker, getConstraints, getEnvironment, getErroredPropItems, getErroredProps, getErrorsProp, getExtendsRootContainer, getFullPropName, getFullPropName, getFullPropNameDebug, getFullPropNameDebug, getListeners, getParent, getParent, getProjectName, getPropAtom, getPropBaseReference, getPropError, getPropError, getPropErroredName, getPropErrorSeverity, getPropExtendsFlags, getPropFromPath, getPropFromPath, getPropFromReference, getPropFromReference, getPropIndex, getPropName, getPropPath, getPropPath, getPropReferenceTarget, getPropRootPropMgr, getPropTreeErrorSeverity, getPropValue, getPropValue, getPropValueObject, getReferencePropName, getReferences, getRelativePropName, getRootFromName, getRootName, getRootParent, getRootParent, getTreeLock, getVSReference, hasChanged, hasPrivateChangeEventProp, hasPropError, hasPropTreeError, info, info, initializeGElement, initializeGProp, isDisposed, isPropChildOf, isPropClientCreated, isPropCommunicating, isPropCreateRequired, isPropExtended, isPropExtendsFinal, isPropExtendsPrivate, isPropExtendsPrivateInRoot, isPropExtendsPrivateInRoot, isPropFile, isPropFolder, isPropForEditor, isPropNullable, isPropPrivate, isPropPrivateAtCreation, isPropReadOnly, isPropReferenceTreeValid, isPropRoot, isPropUSER, isPropValueTreeLockNeeded, isPropVirtualized, isPropVirtualizing, isPropVolatile, isPropVolatileOrEditorOnly, isProxied, list, list, list, list, list, mapAliasToReference, mapAliasToReference, mapReferenceToAlias, mapReferenceToAlias, mapReferenceToProjectRelative, moveProp, moveProp, moveProp, onEvent, onEventSelf, onPrepare, onPropDispose, onPropInvalidateCache, onPropParentChanged, onPropTreeInitialized, onPropValueSet, onReferenceEvent, onRemoteEvent, onVirtualizationCompleted, onVirtualized, paramString, paramValue, post, post, removePropError, removePropListener, removePropUSER, renameProp, renameProp2, resetChangedTree, resolveRuntimeReferences, setChanged, setConstraints, setConstraints, setCreateRequiredProp, setParent, setPrivateChangeEventProp, setPrivateCreateRequiredProp, setPropError, setPropErroredName, setPropExtended, setPropExtendsFinal, setPropExtendsPrivate, setPropForEditor, setPropNullable, setPropPrivate, setPropReadOnly, setPropUSER, setPropValue, setPropValue, setPropValue, setPropValueIncognito, setPropVolatile, severe, severe, severe, shouldSerializeToXML, throwIfReadOnly, toElementString, toNativeValue, toString, toString, triggerRemoteEvent, triggerRemoteEvent, validateProp, validatePropValue, verify, verifyHasPropertyItem, virtualize, warning, warning, warning

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

StringArrayProp

protected StringArrayProp()

Creates an string array with no name and an empty synchronized ArrayList<String> array.

StringArrayProp

public StringArrayProp(Atom propertyAtom)

Creates an string array property with the specified name with an empty synchronized ArrayList<String> array.

Parameters:

propertyAtom - the property atom.

StringArrayProp

public StringArrayProp(Atom propertyAtom,
                       List<String> newValue)
                throws PropTypeException

Creates an string array property with the specified name with an empty synchronized ArrayList<String> array initialized with the specified strings.

Parameters:

propertyAtom - the property atom.

newValue - the new string array value for the property.

Throws:

PropTypeException - If the property is read-only.

Method Detail

createUnmodifiableReadOnly

public static StringArrayProp createUnmodifiableReadOnly(Atom atom,
                                                         String[] strings)

Creates a new StringArrayProp from a predefined array of strings that is placed in an unmodifiable list. The StringArrayProp is marked as read-only.

Parameters:

atom - The name of the property.

strings - The strings.

Returns:

A new read-only property that has an unmodifiable array list.

getValueClasses

public Class<?>[] getValueClasses()

Gets the list of possible native Java classes that can be used to set a value using setPropertyValue, in order of importance. Note that loss of precision in data if e.g. an Float property accepts a Double. However, the setPropertyValue throws IllegalArgumentException if the range in invalid, e.g. conversion of a Integer to a Byte, and the value is not -127 to 128.

Specified by:

getValueClasses in interface IGProp<List<String>>

Specified by:

getValueClasses in class GProp<List<String>>

Returns:

The array of Java classes that can be accepted in the setPropertyValue method. The first type is the "native" or most preferred type. The array is at least one item in length and never null.

clone

public StringArrayProp clone()

Creates a clone out of this property. The cloning is overridden by the subclasses in order to handle cloning of its class variables appropriately.

Cloning is used for "virtualization" of a property tree in the server. Client property classes will therefore throw CloneNotSupportedException.

Once a tree has been cloned, the change-flag is reset, and the create-flag is set. All listeners are also removed! The new cloned property is an orphan, i.e. has no parent set.

Note that the cloning process is done WITHOUT thread synchronization for performance reasons, thus no modifications should be done to the tree!

The StringArrayProperty clones the ArrayList used for the items unless it is a read-only unmodifiable list in which case it is copied.

Overrides:

clone in class GProp<List<String>>

validatePropType

public void validatePropType(Object newValue)
                      throws PropTypeException

Validates that the value to set is of List<?> instance. Later, when setting the property, the method modifyPropertyValue will be called, and this one will require the type List<String> in order not to throw PropertyException.

Specified by:

validatePropType in interface IGProp<List<String>>

Specified by:

validatePropType in class GProp<List<String>>

Parameters:

newValue - The new value to set.

Throws:

PropTypeException - if newValue is not of List<?> instance.

modifyPropValue

protected int modifyPropValue(Object oldValue,
                              Object newValue,
                              PropMgr propMgr)
                       throws PropException

Called when setting a new value for this property. This method is normally not overridden by subclasses, but e.g. for properties containing arrays, this may be handled here, in order not modify the "oldValue" (such as an array, but rather to change it with the data from the "newValue").

Overrides:

modifyPropValue in class GProp<List<String>>

Parameters:

oldValue - The old value.

newValue - The new value.

propMgr - The property manager for remote change, null for local.

Returns:

0 for same value as current value, 2 to indicate the current value has been modified with new contents.

Throws:

PropException - when the new value doesn't validate correctly.

appendPropValue

protected void appendPropValue(PropMgr propertyManager,
                               Transaction trans,
                               Object value)

Appends the string array to an outgoing transaction.

Specified by:

appendPropValue in class GProp<List<String>>

Parameters:

propertyManager - the property manager instance.

trans - transaction to append the properties to.

value - the value to append to the transaction, a reference to the current property value.

initializeValue

public boolean initializeValue(PropMgr propertyManager,
                               Transaction trans)

Initializes the property value from a transaction.

Specified by:

initializeValue in class GProp<List<String>>

Parameters:

propertyManager - the property manager.

trans - the transaction to initialize the property with.

Returns:

true if the value has changed, false otherwise.

initializeProp

public void initializeProp(Element element)
                    throws PropException

Called to initialize the property from an Element. The property should initialize itself from attributes and nodes with appropriate information.

Overrides:

initializeProp in class GProp<List<String>>

Parameters:

element - The Element.

Throws:

PropException - when the initialization fails.

sortList

public void sortList()
              throws PropTypeException

Sorts the list according to the default JVM locale.

Throws:

PropTypeException - If the property is read-only.

sortList

public void sortList(boolean isCaseInsensitive)
              throws PropTypeException

Sorts the list according to the default JVM locale.

Parameters:

isCaseInsensitive - Flag for case insensitive.

Throws:

PropTypeException - If the property is read-only.

sortList

public void sortList(Locale locale)
              throws PropTypeException

Sorts the list according to a locale.

Parameters:

locale - The locale to use for string sorting.

Throws:

PropTypeException - If the property is read-only.

sortList

public void sortList(Locale locale,
                     boolean isCaseInsensitive)
              throws PropTypeException

Sorts the list according to a locale.

Parameters:

locale - The locale to use for string sorting, null for default..

isCaseInsensitive - Flag for case insensitive.

Throws:

PropTypeException - If the property is read-only.

initializeElement

public void initializeElement(Element element)

Called when the XML file for the property tree is serialized from properties. The property should fill attributes and nodes with appropriate information.

The attribute "sort" may be set to "client", "server" or not present, i.e. no sorting. The setting "server" indicates that the Server provides the sorting rule to use, settable for each client session programmatically.

After the element, elements "string" builds up all text entries containing the strings.

Overrides:

initializeElement in class GProp<List<String>>

Parameters:

element - The Element.

addString

public void addString(String s)
               throws PropTypeException

Adds a string to the array.

Parameters:

s - the string to add.

Throws:

PropTypeException - If the property is read-only.

addString

public void addString(String s,
                      int index)
               throws PropTypeException

Adds (inserts) a string at the requested index in the array.

Parameters:

s - the string to add.

index - the index of the string to insert in the array.

Throws:

PropTypeException - If the property is read-only.

addStrings

public void addStrings(List<String> newStringList)
                throws PropTypeException

Adds all strings from a list.

Parameters:

newStringList - the list of new strings to add.

Throws:

PropTypeException - If the property is read-only.

addStrings

public void addStrings(String[] strings)
                throws PropTypeException

Adds all strings from a string array.

Parameters:

strings - the array of new strings to add.

Throws:

PropTypeException - If the property is read-only.

size

public int size()

Gets the string count in the array.

Returns:

int, the string count.

clear

public boolean clear()
              throws PropTypeException

Removes all strings from the array.

Returns:

boolean, true if the was changed, false for no change.

Throws:

PropTypeException - If the property is read-only.

removeString

public boolean removeString(String s)
                     throws PropTypeException

Removes the request string from the array.

Parameters:

s - the string to remove.

Returns:

boolean, true for success, false for string not found.

Throws:

PropTypeException - If the property is read-only.

removeString

public String removeString(int index)
                    throws PropTypeException

Removes a string in the at a specific index.

Parameters:

index - the index in the array to remove.

Returns:

the string that was removed.

Throws:

PropTypeException - If the property is read-only.

getString

public String getString(int index)

Gets a string from a specific index in the array.

Parameters:

index - the index of the string.

Returns:

the requested string at the specified index.

setString

public String setString(String s,
                        int index)
                 throws PropTypeException

Sets a string at a specific index in the array.

Parameters:

s - the string.

index - the index of the string to set.

Returns:

the previous string value of the index.

Throws:

PropTypeException - If the property is read-only.

getArrayList

public List<String> getArrayList()

Gets the synchronized ArrayList<String> of all strings. Be careful with manipulating the string, because no changed-events are fired! They must explicitly be set using the setChanged method. Accessing the list directly is enabled for performance reasons only.

Returns:

The synchronized List<String> if the property is not read-only, otherwise an unmodifiable synchronized List<String>.

getPropValue0

protected Object getPropValue0(Object value,
                               int index)
                        throws Exception

Gets the property value in another class form than the "native" one. This method tries conversion of a "native" property value into another class type. This method is used when filling in a POJO variable (Plain Old Java Object Field) from a "native" property value.

Specified by:

getPropValue0 in class GProp<List<String>>

Parameters:

value - The property value.

index - The index in the Class array returned by getValueClasses().

Returns:

The property value in the requested class, after conversion.

Throws:

Exception - Other exceptions that could occur.

toNativeValue0

protected Object toNativeValue0(Object value,
                                int index)
                         throws Exception

Tries conversion of possibly accepted properties values using the setPropertyValue method into the most preferred property value type. If the input value already is of the preferred type, the same object is returned.

Specified by:

toNativeValue0 in class GProp<List<String>>

Parameters:

value - The input value to convert to native value.

index - The index in the array returned by getValueClasses(), or -1 if not found.

Returns:

The converted input value in the preferred property value object type.

Throws:

Exception - For conversion exceptions.