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

java.lang.Object
  extended by com.microsoft.tfs.core.clients.versioncontrol.VersionControlConstants

public abstract class VersionControlConstants
extends java.lang.Object

Contains constant strings and numbers used by the version control client.

Thread-safety:
immutable
Since:
TEE-SDK-10.1

Field Summary
static java.lang.String AUTHENTICATED_USER
          This string means the currently authenticated user when used as a username/owner parameter.
static java.lang.String CHANGESET_ARTIFACT_TYPE
          The artifact type of changesets.
static java.lang.String CHANGESET_QUERY_STRING
           
static int CHECKIN_NOTE_NAME_SIZE
          The maximum length of a check-in note name in characters.
static java.lang.String CHECKIN_POLICIES_ANNOTATION
           
static java.lang.String CONTENT_FIELD
           
static int DESTROYED_FILE_ID
           
static int ENCODING_BINARY
           
static int ENCODING_FOLDER
          Only meaningful on the server and on the client for local workspace servicing.
static int ENCODING_UNCHANGED
           
static java.lang.String EXCEPTION_HEADER
           
static java.lang.String EXCLUSIVE_CHECKOUT_ANNOTATION
           
static java.lang.String GET_LATEST_ON_CHECKOUT_ANNOTATION
           
static java.lang.String HASH_FIELD
           
static int INDETERMINATE_CHANGESET
          When an item is in an indeterminate state, the changeset for the version in the workspace will be represented using this number.
static java.lang.String INSTANCE_HEADER
           
static java.lang.String ITEM_DELETED_EXCEPTION
           
static java.lang.String ITEM_EXISTS_EXCEPTION
           
static java.lang.String ITEM_ID_QUERY_STRING
           
static java.lang.String ITEM_NOT_CHECKED_OUT_EXCEPTION
           
static java.lang.String LATEST_ITEM_ARTIFACT_TYPE
          The artifact type of latest items
static java.lang.String LATEST_VERSION_DELETED_EXCEPTION
           
static java.lang.String LENGTH_FIELD
           
static java.lang.String LOCAL_ITEM_OUT_OF_DATE_EXCEPTION
           
static int MAX_CHANGE_SET_NAME_SIZE
          Maximum length of a change set name in characters.
static int MAX_COMMENT_SIZE
          Maximum comment size in characters.
static int MAX_COMPUTER_NAME_SIZE
          Maximum computer name in characters.
static int MAX_GET_RESULTS
          Maximum number of get results to process at one time.
static int MAX_HISTORY_RESULTS
          Maximum rows to be returned by a history query.
static int MAX_IDENTITY_NAME_SIZE
          Maximum length of a user's display name.
static int MAX_LABEL_NAME_SIZE
          The maximum length of a label name in characters.
static int MAX_LOCAL_PATH_COMPONENT_SIZE
          The maximum length in characters of any single path component in a local path.
static int MAX_LOCAL_PATH_SIZE
          Maximum length of a local path including drive letter and separators
static int MAX_MERGES_RESULTS
          Maximum number of merges to be returned when querying for historic merges.
static int MAX_SERVER_PATH_COMPONENT_SIZE
          The maximum length in characters of any single path component in a server path.
static int MAX_SERVER_PATH_SIZE
          Maximum length of a repository path in characters.
static int MAX_WORKSPACE_NAME_SIZE
          Maximum length of a workspace name in characters.
static java.lang.String MERGE_CONFLICT_EXISTS_EXCEPTION
           
static java.lang.String NO_CI_CHECKIN_COMMENT
          If present in a changeset comment, the build service will not trigger continuous integration builds for that changeset
static java.lang.String PENDING_CHANGE_ID_QUERY_STRING
           
static java.lang.String PROXY_BASE_DIR
           
static java.lang.String PROXY_DOWNLOAD_FILE_2005
           
static java.lang.String PROXY_DOWNLOAD_FILE_2008
           
static java.lang.String PROXY_REPOSITORY_ID_QUERY_STRING
           
static java.lang.String RANGE_FIELD
           
static java.lang.String SERVER_ITEM_FIELD
           
static java.lang.String STORYBOARD_ARTIFACT_TYPE
          The artifact type of storyboard
static java.lang.String VERSIONED_ITEM_ARTIFACT_TYPE
          The artifact type of versioned items
static java.lang.String WORKSPACE_NAME_FIELD
           
static java.lang.String WORKSPACE_OWNER_FIELD
           
 
Constructor Summary
VersionControlConstants()
           
 
Method Summary
static java.lang.String[] globalPermissions()
          Get the array of global permissions keywords.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PROXY_BASE_DIR

public static final java.lang.String PROXY_BASE_DIR
See Also:
Constant Field Values
Constant Field Value:
"/VersionControlProxy"

PROXY_DOWNLOAD_FILE_2005

public static final java.lang.String PROXY_DOWNLOAD_FILE_2005
See Also:
Constant Field Values
Constant Field Value:
"/VersionControlProxy/item.asmx"

PROXY_DOWNLOAD_FILE_2008

public static final java.lang.String PROXY_DOWNLOAD_FILE_2008
See Also:
Constant Field Values
Constant Field Value:
"/VersionControlProxy/V1.0/item.asmx"

PROXY_REPOSITORY_ID_QUERY_STRING

public static final java.lang.String PROXY_REPOSITORY_ID_QUERY_STRING
See Also:
Constant Field Values
Constant Field Value:
"rid"

MAX_COMMENT_SIZE

public static final int MAX_COMMENT_SIZE
Maximum comment size in characters.

See Also:
Constant Field Values
Constant Field Value:
2147483647

MAX_COMPUTER_NAME_SIZE

public static final int MAX_COMPUTER_NAME_SIZE
Maximum computer name in characters.

See Also:
Constant Field Values
Constant Field Value:
31

MAX_WORKSPACE_NAME_SIZE

public static final int MAX_WORKSPACE_NAME_SIZE
Maximum length of a workspace name in characters.

See Also:
Constant Field Values
Constant Field Value:
64

MAX_CHANGE_SET_NAME_SIZE

public static final int MAX_CHANGE_SET_NAME_SIZE
Maximum length of a change set name in characters.

See Also:
Constant Field Values
Constant Field Value:
64

MAX_SERVER_PATH_SIZE

public static final int MAX_SERVER_PATH_SIZE
Maximum length of a repository path in characters. Includes $/ at beginning.

See Also:
Constant Field Values
Constant Field Value:
259

MAX_SERVER_PATH_COMPONENT_SIZE

public static final int MAX_SERVER_PATH_COMPONENT_SIZE
The maximum length in characters of any single path component in a server path.

See Also:
Constant Field Values
Constant Field Value:
256

MAX_LOCAL_PATH_SIZE

public static final int MAX_LOCAL_PATH_SIZE
Maximum length of a local path including drive letter and separators

See Also:
Constant Field Values
Constant Field Value:
259

MAX_LOCAL_PATH_COMPONENT_SIZE

public static final int MAX_LOCAL_PATH_COMPONENT_SIZE
The maximum length in characters of any single path component in a local path.

See Also:
Constant Field Values
Constant Field Value:
256

MAX_IDENTITY_NAME_SIZE

public static final int MAX_IDENTITY_NAME_SIZE
Maximum length of a user's display name. From unlen in lmcons.h

See Also:
Constant Field Values
Constant Field Value:
256

MAX_LABEL_NAME_SIZE

public static final int MAX_LABEL_NAME_SIZE
The maximum length of a label name in characters.

See Also:
Constant Field Values
Constant Field Value:
64

CHECKIN_NOTE_NAME_SIZE

public static final int CHECKIN_NOTE_NAME_SIZE
The maximum length of a check-in note name in characters.

See Also:
Constant Field Values
Constant Field Value:
64

MAX_HISTORY_RESULTS

public static final int MAX_HISTORY_RESULTS
Maximum rows to be returned by a history query.

See Also:
Constant Field Values
Constant Field Value:
2147483647

MAX_MERGES_RESULTS

public static final int MAX_MERGES_RESULTS
Maximum number of merges to be returned when querying for historic merges.

See Also:
Constant Field Values
Constant Field Value:
2147483647

MAX_GET_RESULTS

public static final int MAX_GET_RESULTS
Maximum number of get results to process at one time.

See Also:
Constant Field Values
Constant Field Value:
250000

DESTROYED_FILE_ID

public static final int DESTROYED_FILE_ID
See Also:
Constant Field Values
Constant Field Value:
1023

NO_CI_CHECKIN_COMMENT

public static final java.lang.String NO_CI_CHECKIN_COMMENT
If present in a changeset comment, the build service will not trigger continuous integration builds for that changeset

See Also:
Constant Field Values
Constant Field Value:
"***NO_CI***"

INDETERMINATE_CHANGESET

public static final int INDETERMINATE_CHANGESET
When an item is in an indeterminate state, the changeset for the version in the workspace will be represented using this number.

See Also:
Constant Field Values
Constant Field Value:
-1

EXCEPTION_HEADER

public static final java.lang.String EXCEPTION_HEADER
See Also:
Constant Field Values
Constant Field Value:
"X-Hatteras-Exception"

INSTANCE_HEADER

public static final java.lang.String INSTANCE_HEADER
See Also:
Constant Field Values
Constant Field Value:
"X-Hatteras-Instance"

CHANGESET_QUERY_STRING

public static final java.lang.String CHANGESET_QUERY_STRING
See Also:
Constant Field Values
Constant Field Value:
"cs"

ITEM_ID_QUERY_STRING

public static final java.lang.String ITEM_ID_QUERY_STRING
See Also:
Constant Field Values
Constant Field Value:
"itemid"

PENDING_CHANGE_ID_QUERY_STRING

public static final java.lang.String PENDING_CHANGE_ID_QUERY_STRING
See Also:
Constant Field Values
Constant Field Value:
"pcid"

SERVER_ITEM_FIELD

public static final java.lang.String SERVER_ITEM_FIELD
See Also:
Constant Field Values
Constant Field Value:
"item"

WORKSPACE_NAME_FIELD

public static final java.lang.String WORKSPACE_NAME_FIELD
See Also:
Constant Field Values
Constant Field Value:
"wsname"

WORKSPACE_OWNER_FIELD

public static final java.lang.String WORKSPACE_OWNER_FIELD
See Also:
Constant Field Values
Constant Field Value:
"wsowner"

HASH_FIELD

public static final java.lang.String HASH_FIELD
See Also:
Constant Field Values
Constant Field Value:
"hash"

CONTENT_FIELD

public static final java.lang.String CONTENT_FIELD
See Also:
Constant Field Values
Constant Field Value:
"content"

LENGTH_FIELD

public static final java.lang.String LENGTH_FIELD
See Also:
Constant Field Values
Constant Field Value:
"filelength"

RANGE_FIELD

public static final java.lang.String RANGE_FIELD
See Also:
Constant Field Values
Constant Field Value:
"range"

CHECKIN_POLICIES_ANNOTATION

public static final java.lang.String CHECKIN_POLICIES_ANNOTATION
See Also:
Constant Field Values
Constant Field Value:
"CheckinPolicies"

EXCLUSIVE_CHECKOUT_ANNOTATION

public static final java.lang.String EXCLUSIVE_CHECKOUT_ANNOTATION
See Also:
Constant Field Values
Constant Field Value:
"ExclusiveCheckout"

GET_LATEST_ON_CHECKOUT_ANNOTATION

public static final java.lang.String GET_LATEST_ON_CHECKOUT_ANNOTATION
See Also:
Constant Field Values
Constant Field Value:
"GetLatestOnCheckout"

AUTHENTICATED_USER

public static final java.lang.String AUTHENTICATED_USER
This string means the currently authenticated user when used as a username/owner parameter.

See Also:
Constant Field Values
Constant Field Value:
"."

ENCODING_BINARY

public static final int ENCODING_BINARY
See Also:
Constant Field Values
Constant Field Value:
-1

ENCODING_UNCHANGED

public static final int ENCODING_UNCHANGED
See Also:
Constant Field Values
Constant Field Value:
-2

ENCODING_FOLDER

public static final int ENCODING_FOLDER
Only meaningful on the server and on the client for local workspace servicing.

See Also:
Constant Field Values
Constant Field Value:
-3

LOCAL_ITEM_OUT_OF_DATE_EXCEPTION

public static final java.lang.String LOCAL_ITEM_OUT_OF_DATE_EXCEPTION
See Also:
Constant Field Values
Constant Field Value:
"LocalItemOutOfDateException"

MERGE_CONFLICT_EXISTS_EXCEPTION

public static final java.lang.String MERGE_CONFLICT_EXISTS_EXCEPTION
See Also:
Constant Field Values
Constant Field Value:
"MergeConflictExistsException"

ITEM_EXISTS_EXCEPTION

public static final java.lang.String ITEM_EXISTS_EXCEPTION
See Also:
Constant Field Values
Constant Field Value:
"ItemExistsException"

ITEM_DELETED_EXCEPTION

public static final java.lang.String ITEM_DELETED_EXCEPTION
See Also:
Constant Field Values
Constant Field Value:
"ItemDeletedException"

LATEST_VERSION_DELETED_EXCEPTION

public static final java.lang.String LATEST_VERSION_DELETED_EXCEPTION
See Also:
Constant Field Values
Constant Field Value:
"LatestVersionDeletedException"

ITEM_NOT_CHECKED_OUT_EXCEPTION

public static final java.lang.String ITEM_NOT_CHECKED_OUT_EXCEPTION
See Also:
Constant Field Values
Constant Field Value:
"ItemNotCheckedOutException"

CHANGESET_ARTIFACT_TYPE

public static final java.lang.String CHANGESET_ARTIFACT_TYPE
The artifact type of changesets.

See Also:
Constant Field Values
Constant Field Value:
"Changeset"

VERSIONED_ITEM_ARTIFACT_TYPE

public static final java.lang.String VERSIONED_ITEM_ARTIFACT_TYPE
The artifact type of versioned items

See Also:
Constant Field Values
Constant Field Value:
"VersionedItem"

LATEST_ITEM_ARTIFACT_TYPE

public static final java.lang.String LATEST_ITEM_ARTIFACT_TYPE
The artifact type of latest items

See Also:
Constant Field Values
Constant Field Value:
"LatestItemVersion"

STORYBOARD_ARTIFACT_TYPE

public static final java.lang.String STORYBOARD_ARTIFACT_TYPE
The artifact type of storyboard

See Also:
Constant Field Values
Constant Field Value:
"Storyboard"
Constructor Detail

VersionControlConstants

public VersionControlConstants()
Method Detail

globalPermissions

public static final java.lang.String[] globalPermissions()
Get the array of global permissions keywords. This method exists so the actual array can be kept private (and thus immutable). Normal public static final arrays can have their contents modified.

Returns:
a new array containing the global permissions keywords.


© 2012 Microsoft. All rights reserved.