Interface IComparedObjects<T>

All Known Implementing Classes:
AbstractComparedEmfObjects, ComparedAdditionalIndexesObjects, ComparedBslModuleSectionDescriptions, ComparedChartObjects, ComparedCmiObjects, ComparedDcsObjects, ComparedEmfObjects, ComparedFormObjects, ComparedHtmlDocumentObjects, ComparedMdObjects, ComparedObjects, ComparedRoleDescriptionObjects, ComparedSymlinks, ComparedUniqueSymlinks, ExtendedComparedBslModuleSectionDescriptions, MatchedEmfObjects, MatchedReference

public interface IComparedObjects<T>
A triple of objects being compared.
  • Method Details

    • getComparedObject

      T getComparedObject(ComparisonSide side)
      Returns a compared object on the specified side.
      Parameters:
      side - the side to get the object for, not null
      Returns:
      the object on the side, may be null
    • getMainObject

      T getMainObject()
      Returns the main object.
      Returns:
      the main object or null
    • getOtherObject

      T getOtherObject()
      Returns the other object.
      Returns:
      the other object or null
    • getCommonAncestorObject

      T getCommonAncestorObject()
      Returns the common ancestor object.
      Returns:
      the common ancestor object or null
    • getObjectSide

      ComparisonSide getObjectSide()
      Returns MAIN or OTHER side if the object presents only on the one of them. Fully ignores object's presence on COMMON_ANCESTOR side.
      Returns:
      the MAIN or OTHER side or null if it presents on both of them or doesn't present on any of them
    • setComparedObject

      void setComparedObject(ComparisonSide side, T object)
      Sets the object on the specified side of the provider.
      Parameters:
      side - the side to set the object for, not null
      object - the object to set
    • getOrder

      int getOrder(ComparisonSide side)
      Returns the order index of the source object from the specified side.
      Parameters:
      side - the side of the object, not null
      Returns:
      the order index or -1 if no order stored
    • setOrder

      void setOrder(ComparisonSide side, int order)
      Sets the order index of a source object on the specified side.
      Parameters:
      side - the side of the source object, not null
      order - the source object order index
    • getPath

      Returns path to the compared object.
      Parameters:
      side - the comparison side to get the path for, not null
      Returns:
      the path to the compared object from the closest top parent, never null
    • setPath

      void setPath(ComparisonSide side, ComparedObjectPath path)
      Sets the path to the compared object.
      Parameters:
      side - the comparison side to set the path for, cannot null
      path - the path to set, cannot be null
    • clone

      Clones the compared object container
      Returns:
      A new instance of the container of the same class. Never null. Internal data should be eligible for safe changes by the caller side
      Throws:
      CloneNotSupportedException - In case if cloning isn't supported