Class ErrorsProp

  • All Implemented Interfaces:
    EventListener, IGProp<java.util.List<GError>>, java.lang.Cloneable

    public class ErrorsProp
    extends GProp<java.util.List<GError>>
    The errors property is used in the designer and files to store error and its values for a container. The container is e.g. a UI panel.

    This property is private and is therefore not transmitted over transactions to a remote party.

    Author:
    Christopher Mindus
    • Constructor Detail

      • ErrorsProp

        protected ErrorsProp()
        Creates an error array with no name and an empty synchronized ArrayList<GError> array.
      • ErrorsProp

        public ErrorsProp​(Atom propertyAtom)
        Creates an error array property with the specified name with an empty synchronized ArrayList<GError> array.
        Parameters:
        propertyAtom - the property atom.
      • ErrorsProp

        public ErrorsProp​(Atom propertyAtom,
                          java.util.List<GError> newValue)
                   throws PropTypeException
        Creates an error array property with the specified name with an empty synchronized ArrayList<GError> array initialized with the specified errors.
        Parameters:
        propertyAtom - the property atom.
        newValue - the new error array value for the property.
        Throws:
        PropTypeException - If the property is read-only.
    • 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.List<GError>>
        Specified by:
        getValueClasses in class GProp<java.util.List<GError>>
        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 ErrorsProp clone()
                         throws java.lang.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 ErrorProperty clones the ArrayList used for the items.

        Overrides:
        clone in class GProp<java.util.List<GError>>
        Throws:
        java.lang.CloneNotSupportedException - If a subclass doesn't allow cloning, e.g. the client properties.
      • validatePropType

        public void validatePropType​(java.lang.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<GError> in order not to throw PropertyException.
        Specified by:
        validatePropType in interface IGProp<java.util.List<GError>>
        Specified by:
        validatePropType in class GProp<java.util.List<GError>>
        Parameters:
        newValue - The new value to set.
        Throws:
        PropTypeException - if newValue is not of List<?> 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.List<GError>>
        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,
                                       java.lang.Object value)
        Appends the error array to an outgoing transaction.
        Specified by:
        appendPropValue in class GProp<java.util.List<GError>>
        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.List<GError>>
        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.
        Overrides:
        initializeProp in class GProp<java.util.List<GError>>
        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.
      • initializeElement

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

        After the element, elements "error" builds up all entries containing the errors.

        Overrides:
        initializeElement in class GProp<java.util.List<GError>>
        Parameters:
        element - The Element.
      • addErrors

        public void addErrors​(java.util.List<GError> newList)
                       throws PropTypeException
        Adds all errors from a list.
        Parameters:
        newList - the list of new errors to add.
        Throws:
        PropTypeException - If the property is read-only.
      • addErrors

        public void addErrors​(GError[] errors)
                       throws PropTypeException
        Adds all errors from an array.
        Parameters:
        errors - the array of new errors to add.
        Throws:
        PropTypeException - If the property is read-only.
      • hasError

        public boolean hasError​(GError error)
        Checks if an error already exists.
        Parameters:
        error - The error.
        Returns:
        true if the error is present, false otherwise.
      • removeError

        public boolean removeError​(GError error)
        Removes a particular error.
        Returns:
        true for success, false if error is not found.
      • size

        public int size()
        Gets the error count in the array.
        Returns:
        int, the error count.
      • clear

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

        public GError removeError​(int index)
                           throws PropTypeException
        Removes an error in the at a specific index.
        Parameters:
        index - the index in the array to remove.
        Returns:
        the error that was removed.
        Throws:
        PropTypeException - If the property is read-only.
      • getError

        public GError getError​(int index)
        Gets an error from a specific index in the array.
        Parameters:
        index - the index of the error.
        Returns:
        the requested error at the specified index.
      • getArrayList

        public java.util.List<GError> getArrayList()
        Gets the synchronized List<GError> of all errors. Be careful with manipulating the errors, 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<GError> if the property is not read-only, otherwise an unmodifiable synchronized List<GError>.
      • 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.List<GError>>
        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.List<GError>>
        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.