Package com.iizix.prop

Class CodeItemArrayProp

java.lang.Object
com.iizix.prop.GProp<List<ICodeItem>>
com.iizix.prop.CodeItemArrayProp
All Implemented Interfaces:
EventListener, ICodeItemArrayContainer, IGProp<List<ICodeItem>>, IKStringArrayContainer, IStringArrayContainer, Cloneable
public class CodeItemArrayProp extends GProp<List<ICodeItem>> implements ICodeItemArrayContainer
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

  • Constructor Details

    • CodeItemArrayProp

      protected CodeItemArrayProp()
      Creates an string array with no name and an empty synchronized ArrayList<String> array.

    • CodeItemArrayProp

      public CodeItemArrayProp(Atom propertyAtom)
      Creates an string array property with the specified name with an empty synchronized ArrayList<String> array.
      Parameters:
      propertyAtom - the property atom.

  • Method Details

    • setOwner

      public void setOwner(ICodeItemsOwner owner)
      Assigns the owner of this container.
      Parameters:
      owner - The new owner, not null.

    • 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<ICodeItem>>
      Specified by:
      getValueClasses in class GProp<List<ICodeItem>>
      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 CodeItemArrayProp 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<ICodeItem>>

    • 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<ICodeItem>>
      Specified by:
      validatePropType in class GProp<List<ICodeItem>>
      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<ICodeItem>>
      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, SendTransaction trans, Object value)
      Appends the string array to an outgoing transaction.
      Specified by:
      appendPropValue in class GProp<List<ICodeItem>>
      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, ReadTransaction trans)
      Initializes the property value from a transaction.
      Specified by:
      initializeValue in class GProp<List<ICodeItem>>
      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<ICodeItem>>
      Parameters:
      element - The Element.
      Throws:
      PropException - when the initialization fails.

    • 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<ICodeItem>>
      Parameters:
      element - The Element.

    • 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<ICodeItem>>
      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<ICodeItem>>
      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.

    • isHTMLKStringSupported

      public boolean isHTMLKStringSupported()
      Checks if KString's of HTML type are supported.
      Specified by:
      isHTMLKStringSupported in interface IKStringArrayContainer
      Returns:
      true for HTML support, false if it must be plain KString's.

    • getItemCount

      public int getItemCount()
      Gets the item count.
      Specified by:
      getItemCount in interface ICodeItemArrayContainer
      Specified by:
      getItemCount in interface IKStringArrayContainer
      Specified by:
      getItemCount in interface IStringArrayContainer
      Returns:
      The count of items.

    • getItems

      public ICodeItem[] getItems()
      Gets the array of elements.
      Specified by:
      getItems in interface ICodeItemArrayContainer
      Returns:
      The array of items.

    • getItemsAsKStrings

      public KString[] getItemsAsKStrings()
      Gets the array of items as KStrings.
      Specified by:
      getItemsAsKStrings in interface IKStringArrayContainer
      Returns:
      An array of KString's.

    • getItem

      public ICodeItem getItem(int index)
      Gets the element at the specified index.
      Specified by:
      getItem in interface ICodeItemArrayContainer
      Parameters:
      index - The index.
      Returns:
      The element.
      Throws:
      IndexOutOfBoundsException - If the index is invalid.

    • getItemIndex

      public int getItemIndex(ICodeItem item)
      Gets the index of of item.
      Specified by:
      getItemIndex in interface ICodeItemArrayContainer
      Parameters:
      item - The item.
      Returns:
      The index of the item, or -1 if not found or item is null.

    • sortItems

      public void sortItems(Locale locale, boolean isCaseInsensitive)
      Sorts the list according to a locale.

      The selected index may change as a result of the sorting if selection is supported.

      Specified by:
      sortItems in interface ICodeItemArrayContainer
      Specified by:
      sortItems in interface IKStringArrayContainer
      Specified by:
      sortItems in interface IStringArrayContainer
      Parameters:
      locale - The locale to use for string sorting, null for default..
      isCaseInsensitive - Flag for case insensitive.
      Throws:
      IllegalStateException - If the container is read-only.

    • addItem

      public void addItem(ICodeItem item)
      Adds a new item.
      Specified by:
      addItem in interface ICodeItemArrayContainer
      Parameters:
      item - The item to add.
      Throws:
      NullPointerException - If the item is null.
      IllegalStateException - If the container is read-only.

    • addItems

      public void addItems(ICodeItem... items)
      Adds a new items.
      Specified by:
      addItems in interface ICodeItemArrayContainer
      Parameters:
      items - The items to add.
      Throws:
      NullPointerException - If an item is null.
      IllegalStateException - If the container is read-only.

    • addItems

      public void addItems(Collection<ICodeItem> items)
      Adds a new items.
      Specified by:
      addItems in interface ICodeItemArrayContainer
      Parameters:
      items - The items to add.
      Throws:
      NullPointerException - If an item is null.
      IllegalStateException - If the container is read-only.

    • addItems

      public void addItems(String... items)
      Adds a new items.
      Specified by:
      addItems in interface IStringArrayContainer
      Parameters:
      items - The items to add.
      Throws:
      NullPointerException - If an item is null.
      IllegalStateException - If the container is read-only.

    • addItems

      public void addItems(KString... items)
      Adds a new items.
      Specified by:
      addItems in interface IKStringArrayContainer
      Parameters:
      items - The items to add.
      Throws:
      NullPointerException - If an item is null.
      IllegalStateException - If the container is read-only.

    • insertItem

      public void insertItem(ICodeItem item, int index)
      Inserts an item at specified index.
      Specified by:
      insertItem in interface ICodeItemArrayContainer
      Parameters:
      item - The item to add.
      index - The index to insert the item before (-1 for last).
      Throws:
      NullPointerException - If the item is null.
      IndexOutOfBoundsException - If the index is in error.
      IllegalStateException - If the container is read-only.

    • setItem

      public ICodeItem setItem(ICodeItem item, int index)
      Sets an item at specified index.
      Specified by:
      setItem in interface ICodeItemArrayContainer
      Parameters:
      item - The item to set.
      index - The index of the item.
      Returns:
      The old item.
      Throws:
      NullPointerException - If the item is null.
      IndexOutOfBoundsException - If the index is in error.
      IllegalStateException - If the container is read-only.

    • removeItem

      public ICodeItem removeItem(int index)
      Removes an item.
      Specified by:
      removeItem in interface ICodeItemArrayContainer
      Specified by:
      removeItem in interface IKStringArrayContainer
      Specified by:
      removeItem in interface IStringArrayContainer
      Parameters:
      index - The index of the item to delete.
      Returns:
      The item deleted.
      Throws:
      IndexOutOfBoundsException - If the index is in error.
      IllegalStateException - If the container is read-only.

    • removeItem

      public int removeItem(ICodeItem item)
      Removes an item.
      Specified by:
      removeItem in interface ICodeItemArrayContainer
      Parameters:
      item - The item to remove.
      Returns:
      The index of the item removed, -1 if not found.
      Throws:
      IndexOutOfBoundsException - If the index is in error.
      IllegalStateException - If the container is read-only.

    • removeItem

      public int removeItem(String item)
      Removes an item.
      Specified by:
      removeItem in interface IStringArrayContainer
      Parameters:
      item - The item to remove.
      Returns:
      The index of the item removed, -1 if not found.
      Throws:
      IndexOutOfBoundsException - If the index is in error.
      IllegalStateException - If the container is read-only.

    • removeItem

      public int removeItem(KString item)
      Removes an item.
      Specified by:
      removeItem in interface IKStringArrayContainer
      Parameters:
      item - The item to remove.
      Returns:
      The index of the item removed, -1 if not found.
      Throws:
      IndexOutOfBoundsException - If the index is in error.
      IllegalStateException - If the container is read-only.

    • removeAllItems

      public void removeAllItems(boolean keepSelection)
      Removes all items but keeps the selection depending on the flag.

      The selection may be changed (cleared) due to this operation if the owner support selection.

      Specified by:
      removeAllItems in interface ICodeItemArrayContainer
      Specified by:
      removeAllItems in interface IKStringArrayContainer
      Specified by:
      removeAllItems in interface IStringArrayContainer
      Parameters:
      keepSelection - The boolean to keep the selection.
      Throws:
      IllegalStateException - If the container is read-only.