com.microsoft.tfs.core.clients.versioncontrol.specs
Class ItemSpec

java.lang.Object
  extended by com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper
      extended by com.microsoft.tfs.core.clients.versioncontrol.specs.ItemSpec

public class ItemSpec
extends com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper

Describes a repository object, using either a local or server path, including an optional deletion ID identifier and a recursion type. It is not generally converted to/from string representation.

Since:
TEE-SDK-10.1

Field Summary
 
Fields inherited from class com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper
webServiceObject
 
Constructor Summary
ItemSpec(ms.tfs.versioncontrol.clientservices._03._ItemSpec spec)
           
ItemSpec()
           
ItemSpec(PendingChange pendingChange)
          Convenience constructor to build an ItemSpec from a PendingChange.
ItemSpec(java.lang.String item, RecursionType recurse)
          Constructs an instance with the following parameters.
ItemSpec(java.lang.String item, RecursionType recurse, int did)
          Constructs an instance with the following parameters.
 
Method Summary
static ItemSpec[] fromStrings(java.lang.String[] localOrServerItems, RecursionType recursion)
          Create item specs from strings.
 int getDeletionID()
           
 java.lang.String getItem()
           
 RecursionType getRecursionType()
           
 ms.tfs.versioncontrol.clientservices._03._ItemSpec getWebServiceObject()
          Gets the web service object this class wraps.
 void setDeletionID(int did)
           
 void setItem(java.lang.String item)
           
 void setRecursionType(RecursionType recurse)
           
 java.lang.String toString()
           
 
Methods inherited from class com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper
equals, hashCode
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ItemSpec

public ItemSpec()

ItemSpec

public ItemSpec(ms.tfs.versioncontrol.clientservices._03._ItemSpec spec)

ItemSpec

public ItemSpec(java.lang.String item,
                RecursionType recurse,
                int did)
Constructs an instance with the following parameters.

Parameters:
item - a local or server path.
recurse - the recursion type.
did - a deletion ID.

ItemSpec

public ItemSpec(java.lang.String item,
                RecursionType recurse)
Constructs an instance with the following parameters.

Parameters:
item - a local or server path.
recurse - the recursion type.

ItemSpec

public ItemSpec(PendingChange pendingChange)
Convenience constructor to build an ItemSpec from a PendingChange.

Parameters:
pendingChange - the PendingChange to build the ItemSpec from (must not be null)
Method Detail

getWebServiceObject

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

Returns:
the web service object this class wraps.

fromStrings

public static ItemSpec[] fromStrings(java.lang.String[] localOrServerItems,
                                     RecursionType recursion)
Create item specs from strings. Item paths and deletion IDs are read from the strings, the given recursion type is applied to all specs. Version specs (other than deletion) encountered parsing the strings will result in a run-time exception.

Parameters:
localOrServerItems - the local or server paths to use (must not be null)
recursion - the type of recursion to use for each item spec (must not be null)
Returns:
the item specs created from the given paths.

getDeletionID

public int getDeletionID()

getItem

public java.lang.String getItem()

getRecursionType

public RecursionType getRecursionType()

setDeletionID

public void setDeletionID(int did)

setItem

public void setItem(java.lang.String item)

setRecursionType

public void setRecursionType(RecursionType recurse)

toString

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


© 2015 Microsoft. All rights reserved.