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

java.lang.Object
  extended by com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper
      extended by com.microsoft.tfs.core.internal.wrappers.EnumerationWrapper
          extended by com.microsoft.tfs.core.clients.versioncontrol.soapextensions.LockLevel

public class LockLevel
extends com.microsoft.tfs.core.internal.wrappers.EnumerationWrapper

Enumerates the types levels available for version control items.

Since:
TEE-SDK-10.1

Field Summary
static LockLevel CHECKIN
           
static LockLevel CHECKOUT
           
static LockLevel NONE
           
static LockLevel UNCHANGED
           
static java.util.HashMap<java.lang.Byte,LockLevel> VALUE_MAP
          A map of enumeration integer values to LockLevel
 
Fields inherited from class com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper
webServiceObject
 
Method Summary
 boolean equals(java.lang.Object o)
           
static LockLevel fromByteValue(byte value)
          Gets the LockLevel associated with the specified integer value.
static LockLevel fromWebServiceObject(ms.tfs.versioncontrol.clientservices._03._LockLevel webServiceObject)
          Gets the correct wrapper type for the given web service object.
 byte getValue()
          Returns the integer value associated with this enumeration.
 ms.tfs.versioncontrol.clientservices._03._LockLevel getWebServiceObject()
          Gets the web service object this class wraps.
 int hashCode()
           
 java.lang.String toShortUIString()
          The localized string appropriate for very space-constrained lock level display (command-line client "status /format:brief" command, for example).
 java.lang.String toUIString()
          The localized string appropriate for normal text lock level display (command-line client "status /format:detailed" command, for example).
 
Methods inherited from class com.microsoft.tfs.core.internal.wrappers.EnumerationWrapper
fromWebServiceObject
 
Methods inherited from class com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper
toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

VALUE_MAP

public static final java.util.HashMap<java.lang.Byte,LockLevel> VALUE_MAP
A map of enumeration integer values to LockLevel


NONE

public static final LockLevel NONE

CHECKIN

public static final LockLevel CHECKIN

CHECKOUT

public static final LockLevel CHECKOUT

UNCHANGED

public static final LockLevel UNCHANGED
Method Detail

fromByteValue

public static LockLevel fromByteValue(byte value)
Gets the LockLevel associated with the specified integer value.

Parameters:
value - The integer value for this item type.
Returns:
The LockLevel with the associated integer value.

fromWebServiceObject

public static LockLevel fromWebServiceObject(ms.tfs.versioncontrol.clientservices._03._LockLevel webServiceObject)
Gets the correct wrapper type for the given web service object.

Parameters:
webServiceObject - the web service object (must not be null)
Returns:
the correct wrapper type for the given web service object
Throws:
java.lang.RuntimeException - if no wrapper type is known for the given web service object

getWebServiceObject

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

Returns:
the web service object this class wraps.

getValue

public byte getValue()
Returns the integer value associated with this enumeration.


toUIString

public java.lang.String toUIString()
The localized string appropriate for normal text lock level display (command-line client "status /format:detailed" command, for example).

Returns:
the short string that describes the lock level. If the lock level is null, "none" is returned.

toShortUIString

public java.lang.String toShortUIString()
The localized string appropriate for very space-constrained lock level display (command-line client "status /format:brief" command, for example). The strings returned are one character long.

Returns:
the (very) short string that describes the lock level.

equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper

hashCode

public int hashCode()
Overrides:
hashCode in class com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper


© 2015 Microsoft. All rights reserved.