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

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

public final class PendChangesOptions
extends com.microsoft.tfs.util.BitField

Options that affect how pending changes are created.

See Also:
Serialized Form
Since:
TEE-SDK-10.1
Thread-safety:
thread-safe

Field Summary
static PendChangesOptions APPLY_LOCAL_ITEM_EXCLUSIONS
          If true, applies the local item exlusion lists (see Workstation) for items found by searching in a directory or matching a wildcard.
static PendChangesOptions FORCE_CHECK_OUT_LOCAL_VERSION
          This instructs the server to force "CheckOut Local Version" behavior.
static PendChangesOptions GET_LATEST_ON_CHECKOUT
          The client requests to synchronize to the latest version of an item on Checkout (PendingEdit).
static PendChangesOptions NONE
           
static PendChangesOptions SILENT
          This instructs the server not to return GetOps for the operation.
static PendChangesOptions SUPPRESS_ITEM_NOT_FOUND_FAILURES
          This flag instructs the client not to report any Failures returned by the server of type ItemNotFoundException as NonFatalErrors.
static PendChangesOptions TREAT_MISSING_ITEMS_AS_FILES
          Whether items missing on disk should be assumed to be files.
 
Method Summary
 PendChangesOptions combine(PendChangesOptions other)
           
static PendChangesOptions combine(PendChangesOptions[] changeTypes)
           
 boolean contains(PendChangesOptions other)
           
 boolean containsAll(PendChangesOptions other)
           
 boolean containsAny(PendChangesOptions other)
           
 PendChangesOptions remove(PendChangesOptions other)
           
 PendChangesOptions retain(PendChangesOptions 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 PendChangesOptions NONE

GET_LATEST_ON_CHECKOUT

public static final PendChangesOptions GET_LATEST_ON_CHECKOUT
The client requests to synchronize to the latest version of an item on Checkout (PendingEdit). In this case the server will download the latest version of the file to the client.


SILENT

public static final PendChangesOptions SILENT
This instructs the server not to return GetOps for the operation. In the case when GET_LATEST_ON_CHECKOUT and SILENT are enabled, you may still get back a GetOp if you need to GetLatest.


FORCE_CHECK_OUT_LOCAL_VERSION

public static final PendChangesOptions FORCE_CHECK_OUT_LOCAL_VERSION
This instructs the server to force "CheckOut Local Version" behavior. This flag will supercede the GET_LATEST_ON_CHECKOUT flag above if both are specified. This flag will supercede the GET_LATEST_ON_CHECKOUT team project annotation.


SUPPRESS_ITEM_NOT_FOUND_FAILURES

public static final PendChangesOptions SUPPRESS_ITEM_NOT_FOUND_FAILURES
This flag instructs the client not to report any Failures returned by the server of type ItemNotFoundException as NonFatalErrors.


TREAT_MISSING_ITEMS_AS_FILES

public static final PendChangesOptions TREAT_MISSING_ITEMS_AS_FILES
Whether items missing on disk should be assumed to be files.


APPLY_LOCAL_ITEM_EXCLUSIONS

public static final PendChangesOptions APPLY_LOCAL_ITEM_EXCLUSIONS
If true, applies the local item exlusion lists (see Workstation) for items found by searching in a directory or matching a wildcard.

Method Detail

combine

public static PendChangesOptions combine(PendChangesOptions[] changeTypes)

containsAll

public boolean containsAll(PendChangesOptions other)

contains

public boolean contains(PendChangesOptions other)

containsAny

public boolean containsAny(PendChangesOptions other)

remove

public PendChangesOptions remove(PendChangesOptions other)

retain

public PendChangesOptions retain(PendChangesOptions other)

combine

public PendChangesOptions combine(PendChangesOptions other)


© 2015 Microsoft. All rights reserved.