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

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

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

DestroyFlags is used to control the options of a destroy operation.

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

Field Summary
static DestroyFlags AFFECTED_CHANGES
          This will return pended and shelved changes that will be destroyed and not return the entire set of items that will be destroyed.
static DestroyFlags DELETE_WORKSPACE_STATE
          Instructs the server to delete local version rows, working folder mappings pending adds & branches, for any affected workspaces.
static DestroyFlags KEEP_HISTORY
          Keeps history.
static DestroyFlags NONE
          No destroy flags.
static DestroyFlags PREVIEW
          When this flag is specified to destroy, the server does not actually destroy the indicated items.
static DestroyFlags SILENT
          When this flag is specified to destroy, the items that were destroyed are not returned to the client.
static DestroyFlags START_CLEANUP
          When this flag is specified to destroy, the server immediately starts an asynchronous cleanup of the versioned item file content data.
 
Method Summary
 DestroyFlags combine(DestroyFlags other)
           
static DestroyFlags combine(DestroyFlags[] values)
           
 boolean contains(DestroyFlags other)
           
 boolean containsAll(DestroyFlags other)
           
 boolean containsAny(DestroyFlags other)
           
 DestroyFlags remove(DestroyFlags other)
           
 DestroyFlags retain(DestroyFlags 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 DestroyFlags NONE
No destroy flags. The default destroy options will be used.


PREVIEW

public static final DestroyFlags PREVIEW
When this flag is specified to destroy, the server does not actually destroy the indicated items. Instead, it returns the items that would be destroyed if this flag were not specified.


START_CLEANUP

public static final DestroyFlags START_CLEANUP
When this flag is specified to destroy, the server immediately starts an asynchronous cleanup of the versioned item file content data. Normally, destroy immediately removes history data, but defers cleanup of file content to a periodic maintenance job.


KEEP_HISTORY

public static final DestroyFlags KEEP_HISTORY
Keeps history. When this flag is specified, item version history is preserved. This means that the item will still appear in directory listings, history queries, etc. When this flag is specified, a "stopAt" version spec can be specified to the destroy operation that controls how much of the file content data is destroyed.


SILENT

public static final DestroyFlags SILENT
When this flag is specified to destroy, the items that were destroyed are not returned to the client. Normally, the server returns the list of items that were destroyed as a result of the operation.


AFFECTED_CHANGES

public static final DestroyFlags AFFECTED_CHANGES
This will return pended and shelved changes that will be destroyed and not return the entire set of items that will be destroyed.


DELETE_WORKSPACE_STATE

public static final DestroyFlags DELETE_WORKSPACE_STATE
Instructs the server to delete local version rows, working folder mappings pending adds & branches, for any affected workspaces. This should be used only for move cases.

Method Detail

combine

public static DestroyFlags combine(DestroyFlags[] values)

containsAll

public boolean containsAll(DestroyFlags other)

contains

public boolean contains(DestroyFlags other)

containsAny

public boolean containsAny(DestroyFlags other)

remove

public DestroyFlags remove(DestroyFlags other)

retain

public DestroyFlags retain(DestroyFlags other)

combine

public DestroyFlags combine(DestroyFlags other)


© 2015 Microsoft. All rights reserved.