com.microsoft.tfs.core.clients.versioncontrol
Class GetItemsOptions

java.lang.Object
  extended by com.microsoft.tfs.util.BitField
      extended by com.microsoft.tfs.core.clients.versioncontrol.GetItemsOptions
All Implemented Interfaces:
java.io.Serializable

public class GetItemsOptions
extends com.microsoft.tfs.util.BitField

Options which control how item information is retrieved from the server.

See Also:
Serialized Form
Since:
TEE-SDK-10.1

Field Summary
static GetItemsOptions DOWNLOAD
          If set, causes download information to be generated.
static GetItemsOptions INCLUDE_BRANCH_INFO
          Include information on whether an item is a branch object in the system
static GetItemsOptions INCLUDE_RECURSIVE_DELETES
          Instructs the server to return items which are affected by a Recursive Delete
static GetItemsOptions INCLUDE_SOURCE_RENAMES
          Include items which are the source of a rename.
static GetItemsOptions LOCAL_ONLY
          Only available in local workspaces.
static GetItemsOptions NONE
          Default behavior.
static GetItemsOptions UNSORTED
          Speeds up GetItems() by not sorting the result items.
 
Method Summary
 GetItemsOptions combine(GetItemsOptions other)
           
static GetItemsOptions combine(GetItemsOptions[] values)
           
 boolean contains(GetItemsOptions other)
           
 boolean containsAll(GetItemsOptions other)
           
 boolean containsAny(GetItemsOptions other)
           
 GetItemsOptions remove(GetItemsOptions other)
           
 GetItemsOptions retain(GetItemsOptions other)
           
 
Methods inherited from class com.microsoft.tfs.util.BitField
combine, combineInternal, containsAllInternal, containsAnyInternal, containsInternal, equals, fromStringValues, getCombinedSpecialFlags, hashCode, isEmpty, registerStringValue, registerStringValue, removeInternal, retainInternal, toFullStringValues, toIntFlags, toString, toStringValues
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

NONE

public static final GetItemsOptions NONE
Default behavior. Sorting is performed and no download information is generated.


DOWNLOAD

public static final GetItemsOptions DOWNLOAD
If set, causes download information to be generated. Set this only if you plan to download the file's contents after calling GetItems().


UNSORTED

public static final GetItemsOptions UNSORTED
Speeds up GetItems() by not sorting the result items.


INCLUDE_BRANCH_INFO

public static final GetItemsOptions INCLUDE_BRANCH_INFO
Include information on whether an item is a branch object in the system

Since:
TFS 2010

INCLUDE_SOURCE_RENAMES

public static final GetItemsOptions INCLUDE_SOURCE_RENAMES
Include items which are the source of a rename.

Since:
TFS 2010

LOCAL_ONLY

public static final GetItemsOptions LOCAL_ONLY
Only available in local workspaces. Will cause the retrieval of items from the local table, without making a server call.

Since:
TFS 2012

INCLUDE_RECURSIVE_DELETES

public static final GetItemsOptions INCLUDE_RECURSIVE_DELETES
Instructs the server to return items which are affected by a Recursive Delete

Since:
TFS 2012
Method Detail

combine

public static GetItemsOptions combine(GetItemsOptions[] values)

containsAll

public boolean containsAll(GetItemsOptions other)

contains

public boolean contains(GetItemsOptions other)

containsAny

public boolean containsAny(GetItemsOptions other)

remove

public GetItemsOptions remove(GetItemsOptions other)

retain

public GetItemsOptions retain(GetItemsOptions other)

combine

public GetItemsOptions combine(GetItemsOptions other)


© 2015 Microsoft. All rights reserved.