org.nuxeo.ecm.platform.content.template.service

Class FactoryBindingRegistry

java.lang.Object

org.nuxeo.runtime.model.ContributionFragmentRegistry<FactoryBindingDescriptor>

org.nuxeo.ecm.platform.content.template.service.FactoryBindingRegistry

public class FactoryBindingRegistry
extends ContributionFragmentRegistry<FactoryBindingDescriptor>

Since:

9.3

Nested Class Summary

Nested classes/interfaces inherited from class org.nuxeo.runtime.model.ContributionFragmentRegistry

ContributionFragmentRegistry.Fragment<T>, ContributionFragmentRegistry.FragmentList<T>

Field Summary

Fields inherited from class org.nuxeo.runtime.model.ContributionFragmentRegistry

contribs

Constructor Summary

Constructors

Constructor and Description
FactoryBindingRegistry()

Method Summary

Modifier and Type	Method and Description
FactoryBindingDescriptor	clone(FactoryBindingDescriptor orig) CLone the given contribution object
void	contributionRemoved(String id, FactoryBindingDescriptor origContrib) All the fragments in the contribution was removed.
void	contributionUpdated(String id, FactoryBindingDescriptor contrib, FactoryBindingDescriptor newOrigContrib) Adds or updates a contribution.
FactoryBindingDescriptor	getContribution(String docTypeOrFacet) Get a merged contribution directly from the internal registry - and avoid passing by the implementation registry.
String	getContributionId(FactoryBindingDescriptor contrib) Returns the contribution ID given the contribution object
void	merge(FactoryBindingDescriptor src, FactoryBindingDescriptor dst) Merge 'src' into 'dst'.

Methods inherited from class org.nuxeo.runtime.model.ContributionFragmentRegistry

addContribution, addFragment, getFragments, isSupportingMerge, removeContribution, removeContribution, removeFragment, toMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FactoryBindingRegistry

public FactoryBindingRegistry()

Method Detail

getContributionId

public String getContributionId(FactoryBindingDescriptor contrib)

Description copied from class: ContributionFragmentRegistry

Returns the contribution ID given the contribution object

Specified by:

getContributionId in class ContributionFragmentRegistry<FactoryBindingDescriptor>

Returns:

contributionUpdated

public void contributionUpdated(String id,
                                FactoryBindingDescriptor contrib,
                                FactoryBindingDescriptor 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 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.

Specified by:

contributionUpdated in class ContributionFragmentRegistry<FactoryBindingDescriptor>

Parameters:

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 void contributionRemoved(String id,
                                FactoryBindingDescriptor origContrib)

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 class ContributionFragmentRegistry<FactoryBindingDescriptor>

clone

public FactoryBindingDescriptor clone(FactoryBindingDescriptor orig)

Description copied from class: ContributionFragmentRegistry

CLone the given contribution object

Specified by:

clone in class ContributionFragmentRegistry<FactoryBindingDescriptor>

Returns:

merge

public void merge(FactoryBindingDescriptor src,
                  FactoryBindingDescriptor dst)

Description copied from class: ContributionFragmentRegistry

Merge 'src' into 'dst'. When merging only the 'dst' object is modified.

Specified by:

merge in class ContributionFragmentRegistry<FactoryBindingDescriptor>

Parameters:

src - the object to copy over the 'dst' object

dst - this object is modified

getContribution

public FactoryBindingDescriptor getContribution(String docTypeOrFacet)

Description copied from class: ContributionFragmentRegistry

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.

Overrides:

getContribution in class ContributionFragmentRegistry<FactoryBindingDescriptor>

Returns: