com.microsoft.tfs.core.pendingcheckin
Class StandardPendingCheckinPendingChanges

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

public class StandardPendingCheckinPendingChanges
extends java.lang.Object
implements PendingCheckinPendingChanges

Standard implementation of PendingCheckinPendingChanges.

The AffectedTeamProjects object given during construction will be updated by calls to setCheckedPendingChanges(PendingChange[]), so callers can check this collection directly, or must construct a new object if they do not want theirs modified.

Since:
TEE-SDK-10.1
Thread-safety:
thread-safe

Constructor Summary
StandardPendingCheckinPendingChanges(Workspace workspace, PendingChange[] allChanges, PendingChange[] checkedChanges, AffectedTeamProjects affectedTeamProjects, java.lang.String comment)
          The AffectedTeamProjects object given will be modified.
 
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.
 java.lang.String[] getAffectedTeamProjectPaths()
          
 PendingChange[] getAllPendingChanges()
          
 PendingChange[] getCheckedPendingChanges()
          
 java.lang.String getComment()
          
 Workspace getWorkspace()
          
 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 all pending changes for this checkin.
 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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StandardPendingCheckinPendingChanges

public StandardPendingCheckinPendingChanges(Workspace workspace,
                                            PendingChange[] allChanges,
                                            PendingChange[] checkedChanges,
                                            AffectedTeamProjects affectedTeamProjects,
                                            java.lang.String comment)
The AffectedTeamProjects object given will be modified. See class notes.

Parameters:
workspace - the workspace these changes are for (must not be null )
allChanges - all pending changes for this workspace (must not be null)
checkedChanges - the pending changes that are "checked" in the user interface for checkin (must not be null)
affectedTeamProjects - the team projects affected by this checkin (must not be null)
comment - the comment (may be null).
Method Detail

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)

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)

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)

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)

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)

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)

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.

setAllPendingChanges

public void setAllPendingChanges(PendingChange[] changes)
Sets all pending changes for this checkin.

Specified by:
setAllPendingChanges in interface PendingCheckinPendingChanges
Parameters:
changes - all pending changes for this checkin (must not be null)

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.

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)

getComment

public java.lang.String getComment()

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

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)

getWorkspace

public Workspace getWorkspace()

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


© 2015 Microsoft. All rights reserved.