Package com.iizix.prop

Class StringSetProp

java.lang.Object
com.iizix.prop.GProp<Set<String>>
com.iizix.prop.StringSetProp
All Implemented Interfaces:
EventListener, IGProp<Set<String>>, Cloneable
public class StringSetProp extends GProp<Set<String>>
The String Set property class holds the property name and a set of unique strings. Duplicate strings are is ignored. The string set is maintained in a synchronized HashSet<String,String>. Access is allowed directly to this map for performance reasons but no events for entry-changes for the property is fired, this must be done manually by calling setChanged.
Author:
Christopher Mindus

  • Constructor Details

    • StringSetProp

      protected StringSetProp()
      Creates a string set with no name and an empty HashSet<String>.

    • StringSetProp

      public StringSetProp(Atom propertyAtom)
      Creates a string set property with the specified name with an empty HashSet<String>.
      Parameters:
      propertyAtom - the property atom.

  • Method Details

    • 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<Set<String>>
      Specified by:
      getValueClasses in class GProp<Set<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 StringSetProp clone() throws CloneNotSupportedException
      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 StringSetProperty clones the HashSet used for the items.

      Overrides:
      clone in class GProp<Set<String>>
      Throws:
      CloneNotSupportedException - If a subclass doesn't allow cloning, e.g. the client properties.

    • validatePropType

      public void validatePropType(Object newValue) throws PropTypeException
      Validates that the value to set is of Set<?> instance. Later, when setting the property, the method modifyPropertyValue will be called, and this one will require the type Set<String> in order not to throw PropertyException.
      Specified by:
      validatePropType in interface IGProp<Set<String>>
      Specified by:
      validatePropType in class GProp<Set<String>>
      Parameters:
      newValue - The new value to set.
      Throws:
      PropTypeException - if newValue is not of Set<String> 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<Set<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.

    • equalValues

      protected Object equalValues(GProp<?> compareTo, Set<String> thisValue, Set<String> compareValue, int how)
      Checks for property value equality. The object is of the correct type for the respective property type. The Atoms and other properties such as Private/Extends has already been checked for equality or correctness.
      Overrides:
      equalValues in class GProp<Set<String>>
      Parameters:
      compareTo - The comparing-to property that contains the value.
      thisValue - This property value (for synchronization reasons).
      compareValue - Another property value.
      how - Flags EQC_* values for equal checking.
      Returns:
      The property not being equal, null for equal (both values null).

    • appendPropValue

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

    • initializeElement

      protected 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.

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

      Overrides:
      initializeElement in class GProp<Set<String>>
      Parameters:
      element - The Element to initialize.

    • addString

      public boolean addString(String string) throws PropTypeException
      Puts the key and value strings in the map. The string is always unique.
      Parameters:
      string - the string to add.
      Returns:
      true for success, false for failure, i.e. string is a duplicate.
      Throws:
      PropTypeException - If the property is read-only.

    • hasString

      public boolean hasString(String string)
      Checks if a string is present in the set.
      Parameters:
      string - the string to check for.
      Returns:
      true for string present, false when not in set.

    • removeAll

      public boolean removeAll() throws PropTypeException
      Removes all entries from the set.
      Returns:
      boolean, true if the set was changed, false for no change.
      Throws:
      PropTypeException - If the property is read-only.

    • removeString

      public boolean removeString(String string) throws PropTypeException
      Removes the string from the map.
      Parameters:
      string - the string to remove.
      Returns:
      true for success, false if string is not found.
      Throws:
      PropTypeException - If the property is read-only.

    • getSet

      public Set<String> getSet()
      Gets the synchronized Set<String>. Be careful with manipulating the map, because no changed-events are fired! They must explicitly be set using the setChanged method. Accessing the Map directly is enabled for performance reasons only.
      Returns:
      The synchronized Set<String> if the property is not read-only, otherwise an unmodifiable synchronized Set<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<Set<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<Set<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.