Class ContributionFragmentRegistry<T>

    • Method Detail

      • getContributionId

        public abstract String getContributionId​(T contrib)
        Returns the contribution ID given the contribution object
      • contributionUpdated

        public abstract void contributionUpdated​(String id,
                                                 T contrib,
                                                 T newOrigContrib)
        Adds or updates a contribution.

        If the contribution doesn't yet exists then it will be added, otherwise the value will be updated. If the given value is null the existing contribution must be removed.

        The second parameter is the contribution that should be updated when merging, as well as stored and used. This usually represents a clone of the original contribution or a merge of multiple contribution fragments. Modifications on this object at application level will be lost on next method call on the same object id: modifications should be done in the merge(Object, Object) method.

        The last parameter is the new contribution object, unchanged (original) which was neither cloned nor merged. This object should never be modified at application level, because it will be used each time a subsequent merge is done. Also, it never should be stored.

        id - - the id of the contribution that needs to be updated
        contrib - the updated contribution object that
        newOrigContrib - - the new, unchanged (original) contribution fragment that triggered the update.
      • contributionRemoved

        public abstract void contributionRemoved​(String id,
                                                 T origContrib)
        All the fragments in the contribution was removed. Contribution must be unregistered.

        The first parameter is the contribution ID that should be remove and the second parameter the original contribution fragment that as unregistered causing the contribution to be removed.

      • clone

        public abstract T clone​(T orig)
        CLone the given contribution object
      • merge

        public abstract void merge​(T src,
                                   T dst)
        Merge 'src' into 'dst'. When merging only the 'dst' object is modified.
        src - the object to copy over the 'dst' object
        dst - this object is modified
      • addContribution

        public void addContribution​(T contrib)
        Add a new contribution. This will start install the new contribution and will notify the implementation about the value to add. (the final value to add may not be the same object as the one added - but a merge between multiple contributions)
      • removeContribution

        public void removeContribution​(T contrib)
        Remove a contribution. This will uninstall the contribution and notify the implementation about the new value it should store (after re-merging contribution fragments).

        Uses standard equality to check for old objects (useEqualsMethod == false).

        See Also:
        removeContribution(Object, boolean)
      • removeContribution

        public void removeContribution​(T contrib,
                                       boolean useEqualsMethod)
        Remove a contribution. This will uninstall the contribution and notify the implementation about the new value it should store (after re-merging contribution fragments).

        Equality can be controlled from here.

        Contributions come from the runtime that keeps exact instances, so using equality usually makes it possible to remove the exact instance that was contributed by this component (without needing to reference the component name for instance). But when unit-testing, or when registrating contributions that do not come directly from the runtime, regirties need to use the equals method defined on each contribution.

        contrib - the contrib to remove
        useEqualsMethod - a boolean stating that old contributions should be checked using the equals method instead of
      • getContribution

        protected T getContribution​(String id)
        Get a merged contribution directly from the internal registry - and avoid passing by the implementation registry. Note that this operation will invoke a merge of existing fragments if needed.

        Since 5.5, this method has made protected as it should not be used by the service retrieving merged resources (otherwise merge will be done again). If you'd really like to call it, add a public method on your registry implementation that will call it.