com.starbase.starteam.viewcomparemerge
Class AmbiguousMatchException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--java.lang.RuntimeException
                    |
                    +--com.starbase.starteam.viewcomparemerge.AmbiguousMatchException

All Implemented Interfaces:

java.io.Serializable

public class AmbiguousMatchException

extends java.lang.RuntimeException

In most VCM sessions, the VCM engine can unambiguously match the root folder of the source view to some folder in the target view, or the root folder of the target view to some folder in the source view. When at least one of the views is a non-derived view, the SDK usually cannot match either root folder, and therefore does not know how the items in the two views are related. In this case, Session.compare() will throw an AmbiguousMatchException. The client application may respond by calling Session.setMatch() to explicitly specify how the ambiguious folder should be matched, followed by a second call to compare().

See Also:

Session.compare(), Session.setMatch(com.starbase.starteam.Item, com.starbase.starteam.Item), Serialized Form

Method Summary

Item	getItem() Gets the item that could not be unambiguously matched, and, as a result, triggered this exception.
boolean	isItemFromSourceView() Indicates whether the ambiguous item resides in the source view or the target view.

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Method Detail

getItem

public Item getItem()

Gets the item that could not be unambiguously matched, and, as a result, triggered this exception.

Note that in practice, the item returned by getItem() is currently always a Folder.

Returns:

An item that could not be matched unambiguously.

See Also:

AmbiguousMatchException.isItemFromSourceView(), #getCandidateMatches

isItemFromSourceView

public boolean isItemFromSourceView()

Indicates whether the ambiguous item resides in the source view or the target view.

Returns:

true if the ambiguous item resides in the source view; false if it resides in the target view.

See Also:

AmbiguousMatchException.getItem()