org.nuxeo.ecm.core.api.operation
Class ModificationSet

java.lang.Object
  org.nuxeo.ecm.core.api.operation.ModificationSet

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<Modification>

public class ModificationSet
extends java.lang.Object
implements java.io.Serializable, java.lang.Iterable<Modification>

A set of modification descriptors.

This class is not thread safe.

Author:

Bogdan Stefanescu

See Also:

Serialized Form

Constructor Summary

ModificationSet()

Method Summary

boolean	add(DocumentRef ref, int modifType)
boolean	add(Modification modif)
boolean	contains(DocumentRef ref)
Modification	get(int index)
Modification	getModifcation(DocumentRef ref) Deprecated.
Modification	getModification(DocumentRef ref) Deprecated. returns a merged modification, unsafe to use this where order of notifications is important
int	indexOf(DocumentRef ref)
java.util.Iterator<Modification>	iterator()
Modification	remove(int index)
Modification	removeModification(DocumentRef ref) Deprecated. returns a merged modification, unsafe to use this where order of notifications is important
int	size()
Modification[]	toArray()

Methods inherited from class java.lang.Object

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

Constructor Detail

ModificationSet

public ModificationSet()

Method Detail

size

public int size()

add

public boolean add(DocumentRef ref,
                   int modifType)

add

public boolean add(Modification modif)

contains

public boolean contains(DocumentRef ref)

get

public final Modification get(int index)

getModification

@Deprecated
public Modification getModification(DocumentRef ref)

Deprecated. returns a merged modification, unsafe to use this where order of notifications is important

Retrieves the merged modification value for the DocumentRef

Parameters:

ref - The document ref

Returns:

Merged modification relating to this document

getModifcation

@Deprecated
public Modification getModifcation(DocumentRef ref)

Deprecated.

Deprecated (spelling mistake in method name). Use getModification insteas.

indexOf

public int indexOf(DocumentRef ref)

remove

public Modification remove(int index)

removeModification

@Deprecated
public Modification removeModification(DocumentRef ref)

Deprecated. returns a merged modification, unsafe to use this where order of notifications is important

Removes any modifications for the provided document ref

Parameters:

ref - The document ref

Returns:

Merged modification relating to this document

toArray

public Modification[] toArray()

iterator

public java.util.Iterator<Modification> iterator()

Specified by:

iterator in interface java.lang.Iterable<Modification>