com.microsoft.tfs.core.pendingcheckin.filters
Class FilterPendingCheckinPendingChanges

java.lang.Object
  extended by com.microsoft.tfs.core.pendingcheckin.filters.FilterPendingCheckinPendingChanges
All Implemented Interfaces:
PendingCheckinPendingChanges

public final class FilterPendingCheckinPendingChanges
extends java.lang.Object
implements PendingCheckinPendingChanges

A PendingCheckinPendingChanges that wraps another PendingCheckinPendingChanges and filters its pending changes before they are returned by its get methods.

Since:
TEE-SDK-10.1
Thread-safety:
immutable

Constructor Summary
FilterPendingCheckinPendingChanges(PendingCheckinPendingChanges realPendingChanges, PendingChangeFilter filter)
           
 
Method Summary
 void addAffectedTeamProjectsChangedListener(AffectedTeamProjectsChangedListener listener)
          Adds a listener that's invoked whenever the team projects affected by this pending checkin are changed.
 void addCheckedPendingChangesChangedListener(CheckedPendingChangesChangedListener listener)
          Adds a listener that's invoked whenever the checked pending changes in the user interface are changed.
 void addCommentChangedListener(CommentChangedListener listener)
          Adds a listener that's invoked whenever the user's check-in comment changes.
 boolean equals(java.lang.Object o)
          
 java.lang.String[] getAffectedTeamProjectPaths()
          
 PendingChange[] getAllPendingChanges()
          
 PendingChange[] getCheckedPendingChanges()
          
 java.lang.String getComment()
          
 Workspace getWorkspace()
          
 int hashCode()
          
 void removeAffectedTeamProjectsChangedListener(AffectedTeamProjectsChangedListener listener)
          Removes a listener that was previously added by PendingCheckinPendingChanges.addAffectedTeamProjectsChangedListener(AffectedTeamProjectsChangedListener) .
 void removeCheckedPendingChangesChangedListener(CheckedPendingChangesChangedListener listener)
          Removes a listener that was previously added by PendingCheckinPendingChanges.addCheckedPendingChangesChangedListener(CheckedPendingChangesChangedListener) .
 void removeCommentChangedListener(CommentChangedListener listener)
          Removes a listener that was previously added by PendingCheckinPendingChanges.addCommentChangedListener(CommentChangedListener) .
 void setAllPendingChanges(PendingChange[] changes)
          Sets the colleciton of all pending changes.
 void setCheckedPendingChanges(PendingChange[] changes)
          Sets the pending changes that are currently "checked" in the user interface for this checkin.
 void setComment(java.lang.String comment)
          Sets the comment for this checkin.
 java.lang.String toString()
          
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

FilterPendingCheckinPendingChanges

public FilterPendingCheckinPendingChanges(PendingCheckinPendingChanges realPendingChanges,
                                          PendingChangeFilter filter)
Method Detail

getCheckedPendingChanges

public PendingChange[] getCheckedPendingChanges()

Specified by:
getCheckedPendingChanges in interface PendingCheckinPendingChanges
Returns:
the pending changes that are currently "checked" in the user interface for this checkin.

addAffectedTeamProjectsChangedListener

public void addAffectedTeamProjectsChangedListener(AffectedTeamProjectsChangedListener listener)
Adds a listener that's invoked whenever the team projects affected by this pending checkin are changed.

Specified by:
addAffectedTeamProjectsChangedListener in interface PendingCheckinPendingChanges
Parameters:
listener - the listener to add (must not be null)

addCheckedPendingChangesChangedListener

public void addCheckedPendingChangesChangedListener(CheckedPendingChangesChangedListener listener)
Adds a listener that's invoked whenever the checked pending changes in the user interface are changed.

Specified by:
addCheckedPendingChangesChangedListener in interface PendingCheckinPendingChanges
Parameters:
listener - the listener to add (must not be null)

addCommentChangedListener

public void addCommentChangedListener(CommentChangedListener listener)
Adds a listener that's invoked whenever the user's check-in comment changes.

Specified by:
addCommentChangedListener in interface PendingCheckinPendingChanges
Parameters:
listener - the listener to add (must not be null)

equals

public boolean equals(java.lang.Object o)

Overrides:
equals in class java.lang.Object

getAffectedTeamProjectPaths

public java.lang.String[] getAffectedTeamProjectPaths()

Specified by:
getAffectedTeamProjectPaths in interface PendingCheckinPendingChanges
Returns:
the team project paths that are affected by changes in this pending checkin.

getAllPendingChanges

public PendingChange[] getAllPendingChanges()

Specified by:
getAllPendingChanges in interface PendingCheckinPendingChanges
Returns:
gets all pending changes for the workspace.

getComment

public java.lang.String getComment()

Specified by:
getComment in interface PendingCheckinPendingChanges
Returns:
the comment for this checkin.

getWorkspace

public Workspace getWorkspace()

Specified by:
getWorkspace in interface PendingCheckinPendingChanges
Returns:
the workspace these changes are in.

hashCode

public int hashCode()

Overrides:
hashCode in class java.lang.Object

removeAffectedTeamProjectsChangedListener

public void removeAffectedTeamProjectsChangedListener(AffectedTeamProjectsChangedListener listener)
Removes a listener that was previously added by PendingCheckinPendingChanges.addAffectedTeamProjectsChangedListener(AffectedTeamProjectsChangedListener) .

Specified by:
removeAffectedTeamProjectsChangedListener in interface PendingCheckinPendingChanges
Parameters:
listener - the listener to remove (must not be null)

removeCheckedPendingChangesChangedListener

public void removeCheckedPendingChangesChangedListener(CheckedPendingChangesChangedListener listener)
Removes a listener that was previously added by PendingCheckinPendingChanges.addCheckedPendingChangesChangedListener(CheckedPendingChangesChangedListener) .

Specified by:
removeCheckedPendingChangesChangedListener in interface PendingCheckinPendingChanges
Parameters:
listener - the listener to remove (must not be null)

removeCommentChangedListener

public void removeCommentChangedListener(CommentChangedListener listener)
Removes a listener that was previously added by PendingCheckinPendingChanges.addCommentChangedListener(CommentChangedListener) .

Specified by:
removeCommentChangedListener in interface PendingCheckinPendingChanges
Parameters:
listener - the listener to remove (must not be null)

setAllPendingChanges

public void setAllPendingChanges(PendingChange[] changes)
Sets the colleciton of all pending changes.

Specified by:
setAllPendingChanges in interface PendingCheckinPendingChanges
Parameters:
changes - the changes (must not be null)

setCheckedPendingChanges

public void setCheckedPendingChanges(PendingChange[] changes)
Sets the pending changes that are currently "checked" in the user interface for this checkin.

Specified by:
setCheckedPendingChanges in interface PendingCheckinPendingChanges
Parameters:
changes - the changes (must not be null)

setComment

public void setComment(java.lang.String comment)
Sets the comment for this checkin.

Specified by:
setComment in interface PendingCheckinPendingChanges
Parameters:
comment - the comment (may be null)

toString

public java.lang.String toString()

Overrides:
toString in class java.lang.Object


© 2015 Microsoft. All rights reserved.