|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.microsoft.tfs.core.clients.versioncontrol.ClientLocalVersionUpdate
public final class ClientLocalVersionUpdate
Contains version information about local working folder files sent to the
server during and after a "get" operation. Supersedes
LocalVersionUpdate
for use within the client SDK, though
LocalVersionUpdate
s are still sent to the server.
Clients must call #close()
to release resources associated with this
class. UpdateLocalVersionQueue
handles closing objects passed to it,
so users of that class do not need to do it.
Constructor Summary | |
---|---|
ClientLocalVersionUpdate(java.lang.String sourceServerItem,
int itemID,
java.lang.String targetLocalItem,
int versionLocal,
java.util.Calendar versionLocalDate,
int encoding,
byte[] baselineHashValue,
long baselineFileLength,
byte[] baselineFileGuid,
java.lang.String pendingChangeTargetServerItem,
PropertyValue[] properties)
|
|
ClientLocalVersionUpdate(java.lang.String sourceServerItem,
int itemID,
java.lang.String targetLocalItem,
int versionLocal,
int encoding,
boolean keepLocalVersionRowOnDelete,
PropertyValue[] properties)
|
|
ClientLocalVersionUpdate(java.lang.String sourceServerItem,
int itemID,
java.lang.String targetLocalItem,
int versionLocal,
PropertyValue[] properties)
|
Method Summary | |
---|---|
void |
generateNewBaselineFileGUID()
|
byte[] |
getBaselineFileGUID()
The baseline file GUID for the baseline for this update |
long |
getBaselineFileLength()
|
byte[] |
getBaselineHashValue()
The MD5 hash value of the baseline for this update |
java.lang.String |
getDownloadURL()
The URL where the baseline for this local version entry can be retrieved |
int |
getEncoding()
|
int |
getItemID()
Item ID corresponding to SourceServerItem (optional; but your calls to UpdateLocalVersion on a pre-Dev11 server will fail if this is not provided). |
boolean |
getKeepLocalVersionEntryOnDelete()
|
long |
getLastModifiedDate()
|
java.lang.String |
getPendingChangeTargetServerItem()
If non-null, EnsureUpdatesFullyPopulated may use QueryPendingChanges as a preferred data source for populating missing baseline information. |
PropertyValue[] |
getPropertyValues()
|
java.lang.String |
getSourceServerItem()
Committed server item of the item whose local version row should be updated, or the target server item if the item is uncommitted (VersionLocal == 0) |
java.lang.String |
getTargetLocalItem()
The path on the local disk where this item is currently located, or null to remove it from the workspace (delete the local version row). |
int |
getVersionLocal()
The version of the item in the workspace. |
long |
getVersionLocalDate()
|
boolean |
isCommitted()
Shorthand property for VersionLocal != 0 |
boolean |
isFullyPopulated(boolean requireLocalVersionDate)
Indicates whether this ClientLocalVersionUpdate has all the fields populated that are necessary to call UpdateLocalVersion for a local workspace. |
boolean |
isSendToServer()
Indicates whether or not this ILocalVersionUpdate is eligible to be transformed into a LocalVersionUpdate/ServerItemLocalVersionUpdate object for use in a webmethod call to UpdateLocalVersion. |
void |
setDownloadURL(java.lang.String value)
|
void |
setLastModifiedDate(long value)
|
void |
setPropertyValues(PropertyValue[] properties)
|
void |
updateFrom(Item item)
Updates the populatable fields of this IPopulatableLocalVersionUpdate from the data in the provided Item object. |
void |
updateFrom(PendingChange pendingChange)
Updates the populatable fields of this IPopulatableLocalVersionUpdate from the data in the provided PendingChange object. |
void |
updateFrom(com.microsoft.tfs.core.clients.versioncontrol.internal.localworkspace.WorkspaceLocalItem lvExisting)
Updates the populatable fields of this IPopulatableLocalVersionUpdate from the data in the provided WorkspaceLocalItem object. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ClientLocalVersionUpdate(java.lang.String sourceServerItem, int itemID, java.lang.String targetLocalItem, int versionLocal, PropertyValue[] properties)
public ClientLocalVersionUpdate(java.lang.String sourceServerItem, int itemID, java.lang.String targetLocalItem, int versionLocal, int encoding, boolean keepLocalVersionRowOnDelete, PropertyValue[] properties)
public ClientLocalVersionUpdate(java.lang.String sourceServerItem, int itemID, java.lang.String targetLocalItem, int versionLocal, java.util.Calendar versionLocalDate, int encoding, byte[] baselineHashValue, long baselineFileLength, byte[] baselineFileGuid, java.lang.String pendingChangeTargetServerItem, PropertyValue[] properties)
Method Detail |
---|
public boolean isSendToServer()
ILocalVersionUpdate
isSendToServer
in interface ILocalVersionUpdate
public boolean isCommitted()
ILocalVersionUpdate
isCommitted
in interface ILocalVersionUpdate
public boolean isFullyPopulated(boolean requireLocalVersionDate)
isFullyPopulated
in interface IPopulatableLocalVersionUpdate
public void updateFrom(Item item)
IPopulatableLocalVersionUpdate
updateFrom
in interface IPopulatableLocalVersionUpdate
item
- Data source to update frompublic void updateFrom(com.microsoft.tfs.core.clients.versioncontrol.internal.localworkspace.WorkspaceLocalItem lvExisting)
IPopulatableLocalVersionUpdate
updateFrom
in interface IPopulatableLocalVersionUpdate
lvExisting
- Data source to update frompublic void updateFrom(PendingChange pendingChange)
IPopulatableLocalVersionUpdate
updateFrom
in interface IPopulatableLocalVersionUpdate
pendingChange
- Data source to update frompublic void generateNewBaselineFileGUID()
public java.lang.String getSourceServerItem()
ILocalVersionUpdate
getSourceServerItem
in interface ILocalVersionUpdate
public int getItemID()
ILocalVersionUpdate
getItemID
in interface ILocalVersionUpdate
public java.lang.String getTargetLocalItem()
ILocalVersionUpdate
getTargetLocalItem
in interface ILocalVersionUpdate
public int getVersionLocal()
ILocalVersionUpdate
getVersionLocal
in interface ILocalVersionUpdate
public long getVersionLocalDate()
public int getEncoding()
public byte[] getBaselineHashValue()
IPopulatableLocalVersionUpdate
getBaselineHashValue
in interface IPopulatableLocalVersionUpdate
public long getBaselineFileLength()
public byte[] getBaselineFileGUID()
IPopulatableLocalVersionUpdate
getBaselineFileGUID
in interface IPopulatableLocalVersionUpdate
public boolean getKeepLocalVersionEntryOnDelete()
public java.lang.String getPendingChangeTargetServerItem()
IPopulatableLocalVersionUpdate
getPendingChangeTargetServerItem
in interface IPopulatableLocalVersionUpdate
public java.lang.String getDownloadURL()
IPopulatableLocalVersionUpdate
getDownloadURL
in interface IPopulatableLocalVersionUpdate
public void setDownloadURL(java.lang.String value)
setDownloadURL
in interface IPopulatableLocalVersionUpdate
public long getLastModifiedDate()
public void setLastModifiedDate(long value)
public PropertyValue[] getPropertyValues()
public void setPropertyValues(PropertyValue[] properties)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |