org.nuxeo.targetplatforms.core.service

Class TargetPackageRegistry

java.lang.Object

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

org.nuxeo.runtime.model.SimpleContributionRegistry<TargetPackageDescriptor>

org.nuxeo.targetplatforms.core.service.TargetPackageRegistry

public class TargetPackageRegistry
extends SimpleContributionRegistry<TargetPackageDescriptor>

Registry for target package contributions, handling merge on "enabled" attribute only.

Since:

5.7.1

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.SimpleContributionRegistry

currentContribs

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

contribs

Constructor Summary

Constructors

Constructor and Description
TargetPackageRegistry()

Method Summary

Modifier and Type	Method and Description
TargetPackageDescriptor	clone(TargetPackageDescriptor orig) CLone the given contribution object
void	contributionUpdated(String id, TargetPackageDescriptor contrib, TargetPackageDescriptor newOrigContrib) Adds or updates a contribution.
String	getContributionId(TargetPackageDescriptor contrib) Returns the contribution ID given the contribution object
TargetPackageDescriptor	getTargetPackage(String id)
List<TargetPackageDescriptor>	getTargetPackages()
List<TargetPackageDescriptor>	getTargetPackages(String targetPlatform)
boolean	isSupportingMerge() Returns true if merge is supported.
void	merge(TargetPackageDescriptor src, TargetPackageDescriptor dst) Merge 'src' into 'dst'.

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

contributionRemoved, getCurrentContribution

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

addContribution, addFragment, getContribution, getFragments, removeContribution, removeContribution, removeFragment, toMap

Methods inherited from class java.lang.Object

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

Constructor Detail

TargetPackageRegistry

public TargetPackageRegistry()

Method Detail

getContributionId

public String getContributionId(TargetPackageDescriptor contrib)

Description copied from class: ContributionFragmentRegistry

Returns the contribution ID given the contribution object

Specified by:

getContributionId in class ContributionFragmentRegistry<TargetPackageDescriptor>

Returns:

contributionUpdated

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

Overrides:

contributionUpdated in class SimpleContributionRegistry<TargetPackageDescriptor>

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.

isSupportingMerge

public boolean isSupportingMerge()

Description copied from class: ContributionFragmentRegistry

Returns true if merge is supported.

Hook method to be overridden if merge logics behind Object.clone() and ContributionFragmentRegistry.merge(Object, Object) cannot be implemented.

Overrides:

isSupportingMerge in class SimpleContributionRegistry<TargetPackageDescriptor>

clone

public TargetPackageDescriptor clone(TargetPackageDescriptor orig)

Description copied from class: ContributionFragmentRegistry

CLone the given contribution object

Overrides:

clone in class SimpleContributionRegistry<TargetPackageDescriptor>

Returns:

merge

public void merge(TargetPackageDescriptor src,
                  TargetPackageDescriptor dst)

Description copied from class: ContributionFragmentRegistry

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

Overrides:

merge in class SimpleContributionRegistry<TargetPackageDescriptor>

Parameters:

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

dst - this object is modified

getTargetPackage

public TargetPackageDescriptor getTargetPackage(String id)

getTargetPackages

public List<TargetPackageDescriptor> getTargetPackages()

getTargetPackages

public List<TargetPackageDescriptor> getTargetPackages(String targetPlatform)