Nuxeo ECM Projects 5.4.3-SNAPSHOT

org.nuxeo.ecm.platform.actions
Class ActionContributionHandler

java.lang.Object
  extended by org.nuxeo.runtime.model.ContributionFragmentRegistry<Action>
      extended by org.nuxeo.ecm.platform.actions.ActionContributionHandler

public class ActionContributionHandler
extends ContributionFragmentRegistry<Action>

Author:
Bogdan Stefanescu

Nested Class Summary
 
Nested classes/interfaces inherited from class org.nuxeo.runtime.model.ContributionFragmentRegistry
ContributionFragmentRegistry.Fragment<T>, ContributionFragmentRegistry.FragmentList<T>
 
Constructor Summary
ActionContributionHandler(ActionFilterRegistry filterReg)
           
 
Method Summary
 Action clone(Action object)
          CLone the given contribution object
 void contributionRemoved(String id, Action origContrib)
          All the fragments in the contribution was removed.
 void contributionUpdated(String actionId, Action action, Action origAction)
          Adds or updates a contribution.
 String getContributionId(Action contrib)
          Returns the contribution ID given the contribution object
 ActionRegistry getRegistry()
           
 void merge(Action source, Action dest)
          Merge 'src' into 'dst'.
 
Methods inherited from class org.nuxeo.runtime.model.ContributionFragmentRegistry
addContribution, getContribution, getFragments, removeContribution
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ActionContributionHandler

public ActionContributionHandler(ActionFilterRegistry filterReg)
Method Detail

getRegistry

public ActionRegistry getRegistry()

clone

public Action clone(Action object)
Description copied from class: ContributionFragmentRegistry
CLone the given contribution object

Specified by:
clone in class ContributionFragmentRegistry<Action>
Returns:

contributionRemoved

public void contributionRemoved(String id,
                                Action 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<Action>

contributionUpdated

public void contributionUpdated(String actionId,
                                Action action,
                                Action origAction)
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<Action>
Parameters:
actionId - - the id of the contribution that needs to be updated
action - the updated contribution object that
origAction - - the new, unchanged (original) contribution fragment that triggered the update.

getContributionId

public String getContributionId(Action contrib)
Description copied from class: ContributionFragmentRegistry
Returns the contribution ID given the contribution object

Specified by:
getContributionId in class ContributionFragmentRegistry<Action>
Returns:

merge

public void merge(Action source,
                  Action dest)
Description copied from class: ContributionFragmentRegistry
Merge 'src' into 'dst'. When merging only the 'dst' object is modified.

Specified by:
merge in class ContributionFragmentRegistry<Action>
Parameters:
source - the object to copy over the 'dst' object
dest - this object is modified

Nuxeo ECM Projects 5.4.3-SNAPSHOT

Copyright © 2011 Nuxeo SAS. All Rights Reserved.