Class StringMapProp

  • All Implemented Interfaces:
    EventListener, IGProp<java.util.Map<java.lang.String,​java.lang.String>>, java.lang.Cloneable
    Direct Known Subclasses:
    XMLSchemaValidatorProp

    public class StringMapProp
    extends GProp<java.util.Map<java.lang.String,​java.lang.String>>
    The String Map property class holds the property name, a map of strings consisting of string keys and string values. Duplicate keys or null values are not allowed. Optionally has a parent and/or property listener(s). The string map is maintained in a synchronized LinkedHashMap<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.

    This property can handle values types as LinkedHashMap<String,String>, Map<String,String>, Hashtable<String,String>.

    Author:
    Christopher Mindus
    • Constructor Detail

      • StringMapProp

        protected StringMapProp()
        Creates an string map with no name and an empty LinkedHashMap<String,String>.
      • StringMapProp

        public StringMapProp​(Atom propertyAtom)
        Creates an string map property with the specified name with an empty LinkedHashMap<String,String>.
        Parameters:
        propertyAtom - the property atom.
    • Method Detail

      • getValueClasses

        public java.lang.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<java.util.Map<java.lang.String,​java.lang.String>>
        Specified by:
        getValueClasses in class GProp<java.util.Map<java.lang.String,​java.lang.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 StringMapProp 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 StrinMapProperty clones the LinkedHashMap used for the items.

        Overrides:
        clone in class GProp<java.util.Map<java.lang.String,​java.lang.String>>
      • validatePropType

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

        protected int modifyPropValue​(java.lang.Object oldValue,
                                      java.lang.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<java.util.Map<java.lang.String,​java.lang.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 java.lang.Object equalValues​(GProp<?> compareTo,
                                               java.util.Map<java.lang.String,​java.lang.String> thisValue,
                                               java.util.Map<java.lang.String,​java.lang.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<java.util.Map<java.lang.String,​java.lang.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,
                                       java.lang.Object value)
        Appends the string map to an outgoing transaction.
        Specified by:
        appendPropValue in class GProp<java.util.Map<java.lang.String,​java.lang.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<java.util.Map<java.lang.String,​java.lang.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​(org.w3c.dom.Element element)
                            throws PropException
        Called to initialize the property from an Element. The property should initialize itself from attributes and nodes with appropriate information.

        This element creates sub-elements "item" that holds a text node.

        Overrides:
        initializeProp in class GProp<java.util.Map<java.lang.String,​java.lang.String>>
        Parameters:
        element - The Element.
        Throws:
        PropException - when the initialization fails.
      • initializeElement

        protected void initializeElement​(org.w3c.dom.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 "entry" builds up all text entries containing the strings in "key" and "value" attributes.

        Overrides:
        initializeElement in class GProp<java.util.Map<java.lang.String,​java.lang.String>>
        Parameters:
        element - The Element to initialize.
      • put

        public java.lang.String put​(java.lang.String key,
                                    java.lang.String value)
                             throws PropTypeException
        Puts the key and value strings in the map. The key is always unique, thus a previous duplicate key removes that entry.
        Parameters:
        key - the key string to add.
        value - the value string to add.
        Returns:
        the previous value associated with key, or null if there was no mapping for key.
        Throws:
        PropTypeException - If the property is read-only.
      • size

        public int size()
        Gets the entry count in the map.
        Returns:
        int, the string count.
      • clear

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

        public java.lang.String removeKey​(java.lang.String key)
                                   throws PropTypeException
        Removes the requested key string from the map.
        Parameters:
        key - the key string to remove.
        Returns:
        String, the previous key entry, null for no previous entry with such a key.
        Throws:
        PropTypeException - If the property is read-only.
      • getValue

        public java.lang.String getValue​(java.lang.String key)
        Gets a value string from a specific key string from the map.
        Parameters:
        key - the key string.
        Returns:
        the value string for the key or null if not found.
      • getHashMap

        public java.util.Map<java.lang.String,​java.lang.String> getHashMap()
        Gets the synchronized LinkedHashMap<String,String>. Be careful with manipulating the map, because no changed-events are fired! They must explicitly be set using the setChanged method. Accessing the LinkedHashMap directly is enabled for performance reasons only.
        Returns:
        The synchronized Map<String,String> if the property is not read-only, otherwise an unmodifiable synchronized Map<String,String>.
      • getPropValue0

        protected java.lang.Object getPropValue0​(java.lang.Object value,
                                                 int index)
                                          throws java.lang.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<java.util.Map<java.lang.String,​java.lang.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:
        java.lang.Exception - Other exceptions that could occur.
      • toNativeValue0

        protected java.lang.Object toNativeValue0​(java.lang.Object value,
                                                  int index)
                                           throws java.lang.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<java.util.Map<java.lang.String,​java.lang.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:
        java.lang.Exception - For conversion exceptions.
      • addSystemProperties

        public boolean addSystemProperties()
                                    throws PropException
        Adds the system properties (of String key and value types) to the environment. SecurityException is handled in case of permissions on the JVM.
        Returns:
        The changed flag.
        Throws:
        PropException - If property is read-only.
      • getStrinMapAsStringArray

        public java.lang.String[] getStrinMapAsStringArray​(java.lang.String delimiter)
        Gets the StringMap as a sorted String array with strings as "name [delimiter] value".