Package org.eclipse.team.ui.mapping

Interface ITeamStateDescription

All Known Implementing Classes:
TeamStateDescription
public interface ITeamStateDescription
A description of the the state of a logical model element with respect to a team repository.

This interface is not intended to be implemented by clients. Clients that wish to create a description should use TeamStateDescription.

Since:
3.2
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object object)
    Return whether this state description is equal the to given object.
    int
    getDirection()
    Return the portion of the state flags that represent the direction associated with the element for which this description was generated.
    int
    getKind()
    Return the portion of the state flags that represent the kind associated with the element for which this description was generated.
    Object
    getProperty(String property)
    Return the value associated with the given property.
    String[]
    getPropertyNames()
    Return the properties names for all decorated properties associated with the element for which this description was generated.
    int
    getStateFlags()
    Return the synchronization state flags for the element for which this state description was generated.

  • Method Details

    • getStateFlags

      int getStateFlags()
      Return the synchronization state flags for the element for which this state description was generated. Only the portion of the synchronization state covered by stateMask used when obtaining this description is returned.
      Returns:
      the synchronization state of the given element
      See Also:

    • getKind

      int getKind()
      Return the portion of the state flags that represent the kind associated with the element for which this description was generated. See IDiff.getKind() for a description of what this value represents.
      Returns:
      the kind associated with the element for which this description was generated

    • getDirection

      int getDirection()
      Return the portion of the state flags that represent the direction associated with the element for which this description was generated. See IThreeWayDiff.getDirection() for a description of what this value represents.
      Returns:
      the direction associated with the element for which this description was generated

    • getPropertyNames

      String[] getPropertyNames()
      Return the properties names for all decorated properties associated with the element for which this description was generated.
      Returns:
      the properties names for all decorated properties

    • getProperty

      Object getProperty(String property)
      Return the value associated with the given property. A null is returned if the property has no value.
      Parameters:
      property - the property
      Returns:
      the value associated with the given property or null

    • equals

      boolean equals(Object object)
      Return whether this state description is equal the to given object. Clients should use this method to test whether two state descriptions are equal.
      Overrides:
      equals in class Object
      Parameters:
      object - the object
      Returns:
      whether this state description is equal the to given object