com.microsoft.tfs.core.clients.versioncontrol.soapextensions
Class LocalPendingChange

java.lang.Object
  extended by com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper
      extended by com.microsoft.tfs.core.clients.versioncontrol.soapextensions.LocalPendingChange

public final class LocalPendingChange
extends com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper

Contains information about a change the user wants to perform to a versioned item (or possibly a newly added item).

Since:
TEE-SDK-11.0

Field Summary
static int LOCAL_PENDING_CHANGE_ID
           
static java.util.Comparator<LocalPendingChange> SERVER_ITEM_COMPARATOR
          Compares the target server paths of local pending changes.
 
Fields inherited from class com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper
webServiceObject
 
Constructor Summary
LocalPendingChange(ms.tfs.versioncontrol.clientservices._03._LocalPendingChange change)
           
LocalPendingChange()
           
LocalPendingChange(java.lang.String targetServerItem, java.lang.String committedServerItem, int version, ItemType itemType, int encoding, byte[] hashValue, int itemId, ChangeType change)
          Used for a candidate add
LocalPendingChange(com.microsoft.tfs.core.clients.versioncontrol.internal.localworkspace.WorkspaceLocalItem lvEntry, java.lang.String targetServerItem, ChangeType change)
           
 
Method Summary
 LocalPendingChange clone()
           
static LocalPendingChange fromPendingChange(PendingChange pc)
          Creates a LocalPendingChange object from a PendingChange that has come down from the server.
 java.lang.String getBranchFromItem()
           
 int getBranchFromVersion()
           
 ChangeType getChangeType()
           
 java.lang.String getCommittedServerItem()
           
 java.util.Calendar getCreationDate()
           
 int getDeletionID()
           
 int getEncoding()
           
 LocalPendingChangeFlags getFlags()
           
 byte[] getHashValue()
           
 int getItemID()
           
 ItemType getItemType()
           
 byte getLockStatus()
           
 PropertyValue[] getPropertyValues()
          Gets the property values for this change.
 java.lang.String getServerItem()
           
 java.lang.String getTargetServerItem()
           
 int getVersion()
           
 ms.tfs.versioncontrol.clientservices._03._LocalPendingChange getWebServiceObject()
          Gets the web service object this class wraps.
 boolean hasMergeConflict()
           
 boolean isAdd()
           
 boolean isBranch()
           
 boolean isCandidate()
           
 boolean isCommitted()
           
 boolean isDelete()
           
 boolean isEdit()
           
 boolean isEncoding()
           
 boolean isLock()
           
 boolean isMerge()
           
 boolean isProperty()
           
 boolean isRecursiveChange()
           
 boolean isRename()
           
 boolean isRollback()
           
 boolean isUndelete()
           
 void setBranchFromItem(java.lang.String value)
           
 void setBranchFromVersion(int value)
           
 void setCandidate(boolean value)
           
 void setChangeType(ChangeType value)
           
 void setCommittedServerItem(java.lang.String value)
           
 void setCreationDate(java.util.Calendar value)
           
 void setDeletionID(int value)
           
 void setEncoding(int value)
           
 void setFlags(LocalPendingChangeFlags value)
           
 void setHashValue(byte[] value)
           
 void setItemID(int value)
           
 void setItemType(ItemType value)
           
 void setLockStatus(byte value)
           
 void setMergeConflict(boolean value)
           
 void setPropertyValues(PropertyValue[] values)
          Sets the property values for this change.
 void setTargetServerItem(java.lang.String value)
           
 void setVersion(int value)
           
 PendingChange toPendingChange(VersionControlClient sourceControl, java.lang.String targetLocalItem)
          Materializes a LocalPendingChange object as a PendingChange to be returned via the public client object model.
 java.lang.String toString()
           
 
Methods inherited from class com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper
equals, hashCode
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

LOCAL_PENDING_CHANGE_ID

public static final int LOCAL_PENDING_CHANGE_ID
Constant Field Value:
-123
See Also:
Constant Field Values

SERVER_ITEM_COMPARATOR

public static final java.util.Comparator<LocalPendingChange> SERVER_ITEM_COMPARATOR
Compares the target server paths of local pending changes.

Constructor Detail

LocalPendingChange

public LocalPendingChange()

LocalPendingChange

public LocalPendingChange(ms.tfs.versioncontrol.clientservices._03._LocalPendingChange change)

LocalPendingChange

public LocalPendingChange(com.microsoft.tfs.core.clients.versioncontrol.internal.localworkspace.WorkspaceLocalItem lvEntry,
                          java.lang.String targetServerItem,
                          ChangeType change)

LocalPendingChange

public LocalPendingChange(java.lang.String targetServerItem,
                          java.lang.String committedServerItem,
                          int version,
                          ItemType itemType,
                          int encoding,
                          byte[] hashValue,
                          int itemId,
                          ChangeType change)
Used for a candidate add

Method Detail

clone

public LocalPendingChange clone()
Overrides:
clone in class java.lang.Object

getWebServiceObject

public ms.tfs.versioncontrol.clientservices._03._LocalPendingChange getWebServiceObject()
Gets the web service object this class wraps. The returned object should not be modified.

Returns:
the web service object this class wraps.

getItemType

public ItemType getItemType()

setItemType

public void setItemType(ItemType value)

getBranchFromItem

public java.lang.String getBranchFromItem()

setBranchFromItem

public void setBranchFromItem(java.lang.String value)

getBranchFromVersion

public int getBranchFromVersion()

setBranchFromVersion

public void setBranchFromVersion(int value)

getCreationDate

public java.util.Calendar getCreationDate()

setCreationDate

public void setCreationDate(java.util.Calendar value)

getCommittedServerItem

public java.lang.String getCommittedServerItem()

setCommittedServerItem

public void setCommittedServerItem(java.lang.String value)

getDeletionID

public int getDeletionID()

setDeletionID

public void setDeletionID(int value)

getEncoding

public int getEncoding()

setEncoding

public void setEncoding(int value)

getHashValue

public byte[] getHashValue()

setHashValue

public void setHashValue(byte[] value)

getItemID

public int getItemID()

setItemID

public void setItemID(int value)

getLockStatus

public byte getLockStatus()

setLockStatus

public void setLockStatus(byte value)

getTargetServerItem

public java.lang.String getTargetServerItem()

setTargetServerItem

public void setTargetServerItem(java.lang.String value)

getServerItem

public java.lang.String getServerItem()

getVersion

public int getVersion()

setVersion

public void setVersion(int value)

getFlags

public LocalPendingChangeFlags getFlags()

setFlags

public void setFlags(LocalPendingChangeFlags value)

getChangeType

public ChangeType getChangeType()

setChangeType

public void setChangeType(ChangeType value)

isCommitted

public boolean isCommitted()

isAdd

public boolean isAdd()

isEdit

public boolean isEdit()

isProperty

public boolean isProperty()

isRename

public boolean isRename()

isEncoding

public boolean isEncoding()

isDelete

public boolean isDelete()

isUndelete

public boolean isUndelete()

isBranch

public boolean isBranch()

isMerge

public boolean isMerge()

isRollback

public boolean isRollback()

isLock

public boolean isLock()

isRecursiveChange

public boolean isRecursiveChange()

hasMergeConflict

public boolean hasMergeConflict()

setMergeConflict

public void setMergeConflict(boolean value)

isCandidate

public boolean isCandidate()

setCandidate

public void setCandidate(boolean value)

getPropertyValues

public PropertyValue[] getPropertyValues()
Gets the property values for this change. Because full property values are not stored for local pending changes, only the properties that fit in the LocalPendingChangeFlags flags field will be returned.

Returns:
the PropertyValues associated with this change (may be null)

setPropertyValues

public void setPropertyValues(PropertyValue[] values)
Sets the property values for this change. Because full property values are not stored for local pending changes, only the properties that fit in the LocalPendingChangeFlags flags field can be saved. Others will be ignored.

Parameters:
values - the properties to set (may be null)

toPendingChange

public PendingChange toPendingChange(VersionControlClient sourceControl,
                                     java.lang.String targetLocalItem)
Materializes a LocalPendingChange object as a PendingChange to be returned via the public client object model.


fromPendingChange

public static LocalPendingChange fromPendingChange(PendingChange pc)
Creates a LocalPendingChange object from a PendingChange that has come down from the server.


toString

public java.lang.String toString()
Overrides:
toString in class com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper


© 2015 Microsoft. All rights reserved.