Class AnnotationsContainer

  • All Implemented Interfaces:
    EventListener, IGProp<java.lang.Object>, java.lang.Cloneable

    public class AnnotationsContainer
    extends GProp<java.lang.Object>
    Annotations container specialized to store annotations as GAnnotation.
    Christopher Mindus
    • Constructor Detail

      • AnnotationsContainer

        public AnnotationsContainer()
        Creates an GAnnotation array with no name and an empty HashMap<String,String>.
      • AnnotationsContainer

        public AnnotationsContainer​(Atom propertyAtom)
        Creates an GAnnotation array property with the specified name with an empty HashMap<String,String>.
        propertyAtom - the property atom.
    • Method Detail

      • onPropDispose

        protected void onPropDispose()
        Called when a property is disposed of by delete/remove in a container, or by the dispose method.
        onPropDispose in class GProp<java.lang.Object>
        See Also:
      • 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.
        Specified by:
        getValueClasses in interface IGProp<java.lang.Object>
        Specified by:
        getValueClasses in class GProp<java.lang.Object>
        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 AnnotationsContainer 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 StrinMapProperty clones the HashMap used for the items.

        clone in class GProp<java.lang.Object>
        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 Map<?,?> instance. Later, when setting the property, the method modifyPropertyValue will be called, and this one will require the type Map<Integer,GAnnotation> in order not to throw PropertyException.
        Specified by:
        validatePropType in interface IGProp<java.lang.Object>
        Specified by:
        validatePropType in class GProp<java.lang.Object>
        newValue - The new value to set.
        PropTypeException - if newValue is not of Map<Integer,GAnnotation> 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").
        modifyPropValue in class GProp<java.lang.Object>
        oldValue - The old value.
        newValue - The new value.
        propMgr - The property manager for remote change, null for local.
        2 for value has changed and it's the same value, 0 for same value as current value.
        PropException - when the new value doesn't validate correctly.
      • appendPropValue

        protected void appendPropValue​(PropMgr propertyManager,
                                       SendTransaction trans,
                                       java.lang.Object value)
        Appends the string array to an outgoing transaction.
        Specified by:
        appendPropValue in class GProp<java.lang.Object>
        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.lang.Object>
        propertyManager - the property manager.
        trans - the transaction to initialize the property with.
        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.

        initializeProp in class GProp<java.lang.Object>
        element - The Element.
        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.

        initializeElement in class GProp<java.lang.Object>
        element - The Element to initialize.
      • 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.lang.Object>
        value - The property value.
        index - The index in the Class array returned by getValueClasses().
        The property value in the requested class, after conversion.
        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.lang.Object>
        value - The input value to convert to native value.
        index - The index in the array returned by getValueClasses(), or -1 if not found.
        The converted input value in the preferred property value object type.
        java.lang.Exception - For conversion exceptions.
      • onEventSelf

        public void onEventSelf​(GEvent event)
        Called when a property event is send to this property.

        A subclass can override this method to perform appropriate processing and is not required to call super.onEventSelf(e).

        Specified by:
        onEventSelf in interface IGProp<java.lang.Object>
        onEventSelf in class GProp<java.lang.Object>
        event - The property event.
      • onReferenceEvent

        protected void onReferenceEvent​(ResolveReferencesEvent event)
        Called to perform reference resolving. A property should override this method if it needs to perform reference resolving and validation.

        Subclasses override this method and only subclasses extending PropCnr needs to call super.onReferenceEvent(ResolveReferenceEvent event).

        onReferenceEvent in class GProp<java.lang.Object>
        event - The resolve references event.