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

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

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

CheckinFlags is used to control the options of a check-in operation. These flags were introduced in 2010, superseding CheckinOptions in this API.

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

Field Summary
static CheckinFlags ALL_CONTENT_UPLOADED
          The server will permit a call to CheckIn with a null or empty list of items to check in, (check-in /all) even if there is a change with the edit bit set.
static CheckinFlags ALLOW_UNCHANGED_CONTENT
          The server will permit items which have a pending edit to be checked in even if the content hasn't changed instead of undoing the change (default)
static CheckinFlags DELETE_SHELVESET
          Delete the shelveset after a successful submission into the repository
static CheckinFlags NO_AUTO_RESOLVE
          The client will not attempt to automatically resolve conflicts arising from the checkin.
static CheckinFlags NONE
          No check-in flags.
static CheckinFlags OVERRIDE_GATED_CHECK_IN
          Bypass gated check-in validation for this check-in
static CheckinFlags QUEUE_BUILD_FOR_GATED_CHECK_IN
          Automatically queue the build for gated check-in validation if possible
static CheckinFlags SUPPRESS_EVENT
          Suppress events for this check-in
static CheckinFlags VALIDATE_CHECK_IN_OWNER
          Make sure that the identity specified as the check-in owner refers to a valid user
 
Method Summary
 CheckinFlags combine(CheckinFlags other)
           
static CheckinFlags combine(CheckinFlags[] values)
           
 boolean contains(CheckinFlags other)
           
 boolean containsAll(CheckinFlags other)
           
 boolean containsAny(CheckinFlags other)
           
 CheckinFlags remove(CheckinFlags other)
           
 CheckinFlags retain(CheckinFlags other)
           
 com.microsoft.tfs.core.clients.versioncontrol.soapextensions.internal.CheckinOptions toCheckinOptions()
          Converts this CheckinFlags to the legacy (TFS 2008 and previous) CheckinOptions type for use with the older web service.
 
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 CheckinFlags NONE
No check-in flags. The default check in options will be used.


VALIDATE_CHECK_IN_OWNER

public static final CheckinFlags VALIDATE_CHECK_IN_OWNER
Make sure that the identity specified as the check-in owner refers to a valid user


SUPPRESS_EVENT

public static final CheckinFlags SUPPRESS_EVENT
Suppress events for this check-in


DELETE_SHELVESET

public static final CheckinFlags DELETE_SHELVESET
Delete the shelveset after a successful submission into the repository


OVERRIDE_GATED_CHECK_IN

public static final CheckinFlags OVERRIDE_GATED_CHECK_IN
Bypass gated check-in validation for this check-in


QUEUE_BUILD_FOR_GATED_CHECK_IN

public static final CheckinFlags QUEUE_BUILD_FOR_GATED_CHECK_IN
Automatically queue the build for gated check-in validation if possible


ALL_CONTENT_UPLOADED

public static final CheckinFlags ALL_CONTENT_UPLOADED
The server will permit a call to CheckIn with a null or empty list of items to check in, (check-in /all) even if there is a change with the edit bit set.


ALLOW_UNCHANGED_CONTENT

public static final CheckinFlags ALLOW_UNCHANGED_CONTENT
The server will permit items which have a pending edit to be checked in even if the content hasn't changed instead of undoing the change (default)


NO_AUTO_RESOLVE

public static final CheckinFlags NO_AUTO_RESOLVE
The client will not attempt to automatically resolve conflicts arising from the checkin. This flag is only honored on TFS2012 servers.

Method Detail

combine

public static CheckinFlags combine(CheckinFlags[] values)

toCheckinOptions

public com.microsoft.tfs.core.clients.versioncontrol.soapextensions.internal.CheckinOptions toCheckinOptions()
Converts this CheckinFlags to the legacy (TFS 2008 and previous) CheckinOptions type for use with the older web service.

Returns:
a CheckinOptions with the options set which correspond to supported CheckinFlags set in this object

containsAll

public boolean containsAll(CheckinFlags other)

contains

public boolean contains(CheckinFlags other)

containsAny

public boolean containsAny(CheckinFlags other)

remove

public CheckinFlags remove(CheckinFlags other)

retain

public CheckinFlags retain(CheckinFlags other)

combine

public CheckinFlags combine(CheckinFlags other)


© 2015 Microsoft. All rights reserved.