xArch/xADL 2.0 Data Binding Library

edu.uci.isr.xarch.diff
Interface IDiff

All Superinterfaces:
IXArchElement
All Known Implementing Classes:
DiffImpl

public interface IDiff
extends IXArchElement

Interface for accessing objects of the Diff xsi:type in the diff namespace.

Author:
Automatically generated by xArch apigen

Field Summary
static XArchTypeMetadata TYPE_METADATA
           
 
Fields inherited from interface edu.uci.isr.xarch.IXArchElement
DEPTH_INFINITY, DEPTH_ONE, DEPTH_ZERO
 
Method Summary
 void addDiffPart(IDiffPart newDiffPart)
          Add a diffPart to this Diff.
 void addDiffParts(Collection diffParts)
          Add a collection of diffParts to this Diff.
 void clearDiffParts()
          Remove all diffParts from this Diff.
 Collection getAllDiffParts()
          Get all the diffParts from this Diff.
 boolean hasAllDiffParts(Collection diffPartsToCheck)
          Determine if this Diff contains each element in the given set of diffParts.
 boolean hasDiffPart(IDiffPart diffPartToCheck)
          Determine if this Diff contains a given diffPart.
 Collection hasDiffParts(Collection diffPartsToCheck)
          Determine if this Diff contains the given set of diffParts.
 boolean isEquivalent(IDiff DiffToCheck)
          Determine if another Diff is equivalent to this one, ignoring ID's.
 void removeDiffPart(IDiffPart diffPartToRemove)
          Remove the given diffPart from this Diff.
 void removeDiffParts(Collection diffParts)
          Remove all the given diffParts from this Diff.
 
Methods inherited from interface edu.uci.isr.xarch.IXArchElement
cloneElement, getInstanceMetadata, getTypeMetadata, getXArch, setXArch
 

Field Detail

TYPE_METADATA

public static final XArchTypeMetadata TYPE_METADATA
Method Detail

addDiffPart

public void addDiffPart(IDiffPart newDiffPart)
Add a diffPart to this Diff.

Parameters:
newDiffPart - diffPart to add.

addDiffParts

public void addDiffParts(Collection diffParts)
Add a collection of diffParts to this Diff.

Parameters:
diffParts - diffParts to add.

clearDiffParts

public void clearDiffParts()
Remove all diffParts from this Diff.


removeDiffPart

public void removeDiffPart(IDiffPart diffPartToRemove)
Remove the given diffPart from this Diff. Matching is done by the isEquivalent(...) function.

Parameters:
diffPartToRemove - diffPart to remove.

removeDiffParts

public void removeDiffParts(Collection diffParts)
Remove all the given diffParts from this Diff. Matching is done by the isEquivalent(...) function.

Parameters:
diffParts - diffPart to remove.

getAllDiffParts

public Collection getAllDiffParts()
Get all the diffParts from this Diff.

Returns:
all diffParts in this Diff.

hasDiffPart

public boolean hasDiffPart(IDiffPart diffPartToCheck)
Determine if this Diff contains a given diffPart.

Returns:
true if this Diff contains the given diffPartToCheck, false otherwise.

hasDiffParts

public Collection hasDiffParts(Collection diffPartsToCheck)
Determine if this Diff contains the given set of diffParts.

Parameters:
diffPartsToCheck - diffParts to check for.
Returns:
Collection of java.lang.Boolean. If the ith element in diffParts was found, then the ith element of the collection will be set to true, otherwise it will be set to false. Matching is done with the isEquivalent(...) method.

hasAllDiffParts

public boolean hasAllDiffParts(Collection diffPartsToCheck)
Determine if this Diff contains each element in the given set of diffParts.

Parameters:
diffPartsToCheck - diffParts to check for.
Returns:
true if every element in diffParts is found in this Diff, false otherwise.

isEquivalent

public boolean isEquivalent(IDiff DiffToCheck)
Determine if another Diff is equivalent to this one, ignoring ID's.

Parameters:
DiffToCheck - Diff to compare to this one.
Returns:
true if all the child elements of this Diff are equivalent, false otherwise.

xArch/xADL 2.0 Data Binding Library