public class PageProviderRegistry extends ContributionFragmentRegistry<PageProviderDefinition>
ContributionFragmentRegistry.Fragment<T>, ContributionFragmentRegistry.FragmentList<T>
Modifier and Type | Field and Description |
---|---|
protected Map<String,PageProviderDefinition> |
providers |
contribs
Constructor and Description |
---|
PageProviderRegistry() |
Modifier and Type | Method and Description |
---|---|
PageProviderDefinition |
clone(PageProviderDefinition orig)
CLone the given contribution object
|
void |
contributionRemoved(String id,
PageProviderDefinition origContrib)
All the fragments in the contribution was removed.
|
void |
contributionUpdated(String id,
PageProviderDefinition desc,
PageProviderDefinition newOrigContrib)
Adds or updates a contribution.
|
String |
getContributionId(PageProviderDefinition contrib)
Returns the contribution ID given the contribution object
|
PageProviderDefinition |
getPageProvider(String id) |
boolean |
isSupportingMerge()
Returns true if merge is supported.
|
void |
merge(PageProviderDefinition src,
PageProviderDefinition dst)
Merge 'src' into 'dst'.
|
addContribution, addFragment, getContribution, getFragments, removeContribution, removeContribution, removeFragment
protected Map<String,PageProviderDefinition> providers
public PageProviderRegistry()
public String getContributionId(PageProviderDefinition contrib)
ContributionFragmentRegistry
getContributionId
in class ContributionFragmentRegistry<PageProviderDefinition>
public void contributionUpdated(String id, PageProviderDefinition desc, PageProviderDefinition newOrigContrib)
ContributionFragmentRegistry
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
ContributionFragmentRegistry.contributionUpdated(String, Object, Object)
call on the same object id: modifications should be done in
the ContributionFragmentRegistry.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.
contributionUpdated
in class ContributionFragmentRegistry<PageProviderDefinition>
id
- - the id of the contribution that needs to be updateddesc
- the updated contribution object thatnewOrigContrib
- - the new, unchanged (original) contribution fragment that triggered the update.public void contributionRemoved(String id, PageProviderDefinition origContrib)
ContributionFragmentRegistry
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.
contributionRemoved
in class ContributionFragmentRegistry<PageProviderDefinition>
public boolean isSupportingMerge()
ContributionFragmentRegistry
Hook method to be overridden if merge logics behind Object.clone()
and ContributionFragmentRegistry.merge(Object, Object)
cannot be
implemented.
isSupportingMerge
in class ContributionFragmentRegistry<PageProviderDefinition>
public PageProviderDefinition clone(PageProviderDefinition orig)
ContributionFragmentRegistry
clone
in class ContributionFragmentRegistry<PageProviderDefinition>
public void merge(PageProviderDefinition src, PageProviderDefinition dst)
ContributionFragmentRegistry
merge
in class ContributionFragmentRegistry<PageProviderDefinition>
src
- the object to copy over the 'dst' objectdst
- this object is modifiedpublic PageProviderDefinition getPageProvider(String id)
Copyright © 2015 Nuxeo SA. All rights reserved.