com.microsoft.tfs.core.clients.versioncontrol.soapextensions
Class ChangeType

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

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

Describes the type of change that applied to an item.

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

Field Summary
static ChangeType ADD
           
static ChangeType ADD_BRANCH_OR_RENAME
           
static ChangeType ADD_EDIT_ENCODING
           
static ChangeType ADD_ENCODING
           
static ChangeType ALL
           
static ChangeType BRANCH
           
static ChangeType DELETE
           
static ChangeType EDIT
           
static ChangeType ENCODING
           
static ChangeType LOCK
           
static ChangeType MERGE
           
static ChangeType NONE
           
static ChangeType PROPERTY
           
static ChangeType RENAME
           
static ChangeType RENAME_OR_DELETE
           
static ChangeType ROLLBACK
           
static ChangeType SOURCE_RENAME
           
static ChangeType TARGET_RENAME
           
static ChangeType UNDELETE
           
 
Constructor Summary
ChangeType(ms.tfs.versioncontrol.clientservices._03._ChangeType flagSet, int flagsExtended)
          Constructs a ChangeType from the given web service object FlagSet.
 
Method Summary
 ChangeType combine(ChangeType other)
           
static ChangeType combine(ChangeType[] changeTypes)
           
 boolean contains(ChangeType other)
           
 boolean containsAll(ChangeType other)
           
 boolean containsAny(ChangeType other)
           
static ChangeType fromIntFlags(int flags)
          Creates a ChangeType for the given integer flags (which may come from BitField.toIntFlags().
static ChangeType fromIntFlags(int flags, int extendedFlags)
          Creates a ChangeType for the given integer flags and extended (2010 style) flags.
 ms.tfs.versioncontrol.clientservices._03._ChangeType getWebServiceObject()
          Gets the web service object.
 int getWebServiceObjectExtendedFlags()
          Gets the extended flag information for this ChangeType, which is sent to TFS with the web service object.
 ChangeType remove(ChangeType other)
           
 ChangeType retain(ChangeType other)
           
 java.lang.String toUIString(boolean showLock)
           
 java.lang.String toUIString(boolean showLock, Change change)
           
 java.lang.String toUIString(boolean showLock, ExtendedItem extendedItem)
           
 java.lang.String toUIString(boolean showLock, Item item)
           
 java.lang.String toUIString(boolean showLock, PendingChange pendingChange)
           
 java.lang.String toUIString(boolean showLock, PropertyValue[] properties)
          Gets a localized string describing the changes in this ChangeType including property change information (if supplied).
 
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 ChangeType NONE

ADD

public static final ChangeType ADD

EDIT

public static final ChangeType EDIT

ENCODING

public static final ChangeType ENCODING

RENAME

public static final ChangeType RENAME

DELETE

public static final ChangeType DELETE

UNDELETE

public static final ChangeType UNDELETE

BRANCH

public static final ChangeType BRANCH

MERGE

public static final ChangeType MERGE

LOCK

public static final ChangeType LOCK

ROLLBACK

public static final ChangeType ROLLBACK

SOURCE_RENAME

public static final ChangeType SOURCE_RENAME

TARGET_RENAME

public static final ChangeType TARGET_RENAME

PROPERTY

public static final ChangeType PROPERTY

ALL

public static final ChangeType ALL

ADD_ENCODING

public static final ChangeType ADD_ENCODING

ADD_EDIT_ENCODING

public static final ChangeType ADD_EDIT_ENCODING

RENAME_OR_DELETE

public static final ChangeType RENAME_OR_DELETE

ADD_BRANCH_OR_RENAME

public static final ChangeType ADD_BRANCH_OR_RENAME
Constructor Detail

ChangeType

public ChangeType(ms.tfs.versioncontrol.clientservices._03._ChangeType flagSet,
                  int flagsExtended)
Constructs a ChangeType from the given web service object FlagSet.

Parameters:
flagSet - the FlagSet (must not be null)
flagsExtended - the extended flag information (pass 0 to enable no extended flags)
Method Detail

getWebServiceObject

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

Returns:
the web service object

getWebServiceObjectExtendedFlags

public int getWebServiceObjectExtendedFlags()
Gets the extended flag information for this ChangeType, which is sent to TFS with the web service object. The extended flags contain bits for the non-extended flags, too.

Returns:
the extended type information flags

combine

public static ChangeType combine(ChangeType[] changeTypes)

containsAll

public boolean containsAll(ChangeType other)

contains

public boolean contains(ChangeType other)

containsAny

public boolean containsAny(ChangeType other)

remove

public ChangeType remove(ChangeType other)

retain

public ChangeType retain(ChangeType other)

combine

public ChangeType combine(ChangeType other)

toUIString

public java.lang.String toUIString(boolean showLock)

toUIString

public java.lang.String toUIString(boolean showLock,
                                   Item item)

toUIString

public java.lang.String toUIString(boolean showLock,
                                   ExtendedItem extendedItem)

toUIString

public java.lang.String toUIString(boolean showLock,
                                   PendingChange pendingChange)

toUIString

public java.lang.String toUIString(boolean showLock,
                                   Change change)

toUIString

public java.lang.String toUIString(boolean showLock,
                                   PropertyValue[] properties)
Gets a localized string describing the changes in this ChangeType including property change information (if supplied).

Parameters:
showLock - if false, the "lock" change type string will not be included if this ChangeType has lock unless lock is the only change type
properties - the PropertyValues to include in the summary if the change type includes a PROPERTY change (may be null to omit the property value information)
Returns:
a localized String that represents this ChangeType

fromIntFlags

public static ChangeType fromIntFlags(int flags)
Creates a ChangeType for the given integer flags (which may come from BitField.toIntFlags().

Parameters:
flags - The integer flags for this ChangeType
Returns:
The appropriate ChangeType

fromIntFlags

public static ChangeType fromIntFlags(int flags,
                                      int extendedFlags)
Creates a ChangeType for the given integer flags and extended (2010 style) flags.

Parameters:
flags - The integer flags for this ChangeType
extendedFlags - The integer extended flags for this ChangeType
Returns:
The appropriate ChangeType


© 2015 Microsoft. All rights reserved.