Class SuggesterGroupRegistry
- java.lang.Object
-
- org.nuxeo.runtime.model.ContributionFragmentRegistry<SuggesterGroupDescriptor>
-
- org.nuxeo.ecm.platform.suggestbox.service.registries.SuggesterGroupRegistry
-
public class SuggesterGroupRegistry extends ContributionFragmentRegistry<SuggesterGroupDescriptor>
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.nuxeo.runtime.model.ContributionFragmentRegistry
ContributionFragmentRegistry.Fragment<T>, ContributionFragmentRegistry.FragmentList<T>
-
-
Field Summary
Fields Modifier and Type Field Description protected Map<String,SuggesterGroupDescriptor>
suggesterGroupDescriptors
-
Fields inherited from class org.nuxeo.runtime.model.ContributionFragmentRegistry
contribs
-
-
Constructor Summary
Constructors Constructor Description SuggesterGroupRegistry()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SuggesterGroupDescriptor
clone(SuggesterGroupDescriptor suggestGroup)
CLone the given contribution objectvoid
contributionRemoved(String id, SuggesterGroupDescriptor arg1)
All the fragments in the contribution was removed.void
contributionUpdated(String id, SuggesterGroupDescriptor contrib, SuggesterGroupDescriptor newOrigContrib)
Adds or updates a contribution.String
getContributionId(SuggesterGroupDescriptor suggestGroup)
Returns the contribution ID given the contribution objectSuggesterGroupDescriptor
getSuggesterGroupDescriptor(String name)
void
merge(SuggesterGroupDescriptor src, SuggesterGroupDescriptor dst)
Merge 'src' into 'dst'.-
Methods inherited from class org.nuxeo.runtime.model.ContributionFragmentRegistry
addContribution, addFragment, getContribution, getFragments, isSupportingMerge, removeContribution, removeContribution, removeFragment, toMap
-
-
-
-
Field Detail
-
suggesterGroupDescriptors
protected final Map<String,SuggesterGroupDescriptor> suggesterGroupDescriptors
-
-
Method Detail
-
getSuggesterGroupDescriptor
public SuggesterGroupDescriptor getSuggesterGroupDescriptor(String name)
-
clone
public SuggesterGroupDescriptor clone(SuggesterGroupDescriptor suggestGroup)
Description copied from class:ContributionFragmentRegistry
CLone the given contribution object- Specified by:
clone
in classContributionFragmentRegistry<SuggesterGroupDescriptor>
-
contributionRemoved
public void contributionRemoved(String id, SuggesterGroupDescriptor arg1)
Description copied from class:ContributionFragmentRegistry
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.
- Specified by:
contributionRemoved
in classContributionFragmentRegistry<SuggesterGroupDescriptor>
-
contributionUpdated
public void contributionUpdated(String id, SuggesterGroupDescriptor contrib, SuggesterGroupDescriptor newOrigContrib)
Description copied from class:ContributionFragmentRegistry
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
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.
- Specified by:
contributionUpdated
in classContributionFragmentRegistry<SuggesterGroupDescriptor>
- Parameters:
id
- - the id of the contribution that needs to be updatedcontrib
- the updated contribution object thatnewOrigContrib
- - the new, unchanged (original) contribution fragment that triggered the update.
-
getContributionId
public String getContributionId(SuggesterGroupDescriptor suggestGroup)
Description copied from class:ContributionFragmentRegistry
Returns the contribution ID given the contribution object- Specified by:
getContributionId
in classContributionFragmentRegistry<SuggesterGroupDescriptor>
-
merge
public void merge(SuggesterGroupDescriptor src, SuggesterGroupDescriptor dst)
Description copied from class:ContributionFragmentRegistry
Merge 'src' into 'dst'. When merging only the 'dst' object is modified.- Specified by:
merge
in classContributionFragmentRegistry<SuggesterGroupDescriptor>
- Parameters:
src
- the object to copy over the 'dst' objectdst
- this object is modified
-
-