|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper
com.microsoft.tfs.core.clients.versioncontrol.soapextensions.Mapping
com.microsoft.tfs.core.clients.versioncontrol.soapextensions.WorkingFolder
public final class WorkingFolder
Represents a Mapping between a server item (by path) and a local
path.
| Field Summary | |
|---|---|
static java.lang.String |
DEPTH_ONE_STRING
A string which is used to represent a depth-one mapping when it is the file part of a server path. |
| Fields inherited from class com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper |
|---|
webServiceObject |
| Constructor Summary | |
|---|---|
WorkingFolder(ms.tfs.versioncontrol.clientservices._03._WorkingFolder wf)
|
|
WorkingFolder(java.lang.String serverItem,
java.lang.String localItem)
|
|
WorkingFolder(java.lang.String serverItem,
java.lang.String localItem,
WorkingFolderType type)
Creates a working folder object that maps a local path to a server path with a recursion type of "full" (the traditional mapping style). |
|
WorkingFolder(java.lang.String serverItem,
java.lang.String localItem,
WorkingFolderType type,
RecursionType recursion)
Creates a working folder object that maps a local path to a server path. |
|
| Method Summary | |
|---|---|
static boolean |
areSetsEqual(WorkingFolder[] set1,
WorkingFolder[] set2)
|
java.lang.Object |
clone()
|
static WorkingFolder[] |
clone(WorkingFolder[] folders)
|
boolean |
equals(java.lang.Object obj)
|
static java.lang.String[] |
extractMappedPaths(WorkingFolder[] workingFolders)
|
java.lang.String |
getLocalItem()
Gets the path to the local item in this working folder mapping. |
static java.lang.String |
getLocalItemForServerItem(java.lang.String serverItem,
WorkingFolder[] folders)
|
static java.lang.String |
getLocalItemForServerItem(java.lang.String serverItem,
WorkingFolder[] folders,
boolean detectImplicitCloak)
|
java.lang.String |
getLocalItemRaw()
Gets the path to the local item in the native TFS path format, which is Windows-style paths (even if this code is running on Unix). |
static java.lang.String |
getServerItemForLocalItem(java.lang.String localItem,
WorkingFolder[] folders)
|
ms.tfs.versioncontrol.clientservices._03._WorkingFolder |
getWebServiceObject()
Gets the web service object this class wraps. |
static java.lang.Iterable<java.lang.String> |
getWorkspaceRoots(WorkingFolder[] workingFolders)
|
int |
hashCode()
|
void |
setLocalItem(java.lang.String item)
Sets the path to the local item in this working folder mapping. |
java.lang.String |
toString()
|
java.lang.String |
translateLocalItemToServerItem(java.lang.String localItem)
Uses this WorkingFolder object as the closest mapping to translate the provided local item to a server item. |
static PathTranslation |
translateLocalItemToServerItem(java.lang.String localPath,
WorkingFolder[] folders)
Translates a local path to a server path using the supplied working folder mappings. |
java.lang.String |
translateServerItemToLocalItem(java.lang.String serverItem)
Uses this WorkingFolder object as the closest mapping to translate the provided server item to a local item. |
static PathTranslation |
translateServerItemToLocalItem(java.lang.String serverPath,
WorkingFolder[] folders,
boolean interpretOneLevelMappingsNormally)
Translates a server path to a local path using the supplied working folder mappings. |
| Methods inherited from class com.microsoft.tfs.core.clients.versioncontrol.soapextensions.Mapping |
|---|
getDepth, getDepthFromRecursion, getDisplayServerItem, getServerItem, getType, isCloaked, setServerItem |
| Methods inherited from class java.lang.Object |
|---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static final java.lang.String DEPTH_ONE_STRING
"*"| Constructor Detail |
|---|
public WorkingFolder(ms.tfs.versioncontrol.clientservices._03._WorkingFolder wf)
public WorkingFolder(java.lang.String serverItem,
java.lang.String localItem)
public WorkingFolder(java.lang.String serverItem,
java.lang.String localItem,
WorkingFolderType type)
serverItem - the server item being mapped (must not be null)localItem - the local path being mapped (may be null for cloak mappings).type - the type of mapping to create (must not be null)
public WorkingFolder(java.lang.String serverItem,
java.lang.String localItem,
WorkingFolderType type,
RecursionType recursion)
localItem - the local path being mapped (may be null for cloak mappings).serverItem - the server item being mapped (must not be null)type - the type of mapping to create (must not be null)recursion - the type of recursion to use for the working folder (must not be
null)| Method Detail |
|---|
public ms.tfs.versioncontrol.clientservices._03._WorkingFolder getWebServiceObject()
public java.lang.String getLocalItemRaw()
public java.lang.String getLocalItem()
public void setLocalItem(java.lang.String item)
item - the local path.public java.lang.String toString()
toString in class com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapperpublic boolean equals(java.lang.Object obj)
equals in class Mappingpublic int hashCode()
hashCode in class Mapping
public static boolean areSetsEqual(WorkingFolder[] set1,
WorkingFolder[] set2)
public static java.lang.Iterable<java.lang.String> getWorkspaceRoots(WorkingFolder[] workingFolders)
public java.lang.String translateServerItemToLocalItem(java.lang.String serverItem)
serverItem - The server item to translate. This must be a subitem of this
WorkingFolder's server item.
public java.lang.String translateLocalItemToServerItem(java.lang.String localItem)
localItem - The local item to translate. This must be a subitem of this
WorkingFolder's local item.
public java.lang.Object clone()
clone in class java.lang.Objectpublic static WorkingFolder[] clone(WorkingFolder[] folders)
public static java.lang.String[] extractMappedPaths(WorkingFolder[] workingFolders)
public static java.lang.String getLocalItemForServerItem(java.lang.String serverItem,
WorkingFolder[] folders)
public static java.lang.String getLocalItemForServerItem(java.lang.String serverItem,
WorkingFolder[] folders,
boolean detectImplicitCloak)
public static java.lang.String getServerItemForLocalItem(java.lang.String localItem,
WorkingFolder[] folders)
public static PathTranslation translateLocalItemToServerItem(java.lang.String localPath,
WorkingFolder[] folders)
Translates a local path to a server path using the supplied working folder mappings.
A PathTranslation is returned for items that are cloaked and the
translated item will be non-null.
localPath - the local path to translate into a server path (must not be
null or empty)folders - the WorkingFolder mappings to translate with; can be
arranged in any order (must not be null)
null if the item
is not mapped
public static PathTranslation translateServerItemToLocalItem(java.lang.String serverPath,
WorkingFolder[] folders,
boolean interpretOneLevelMappingsNormally)
Translates a server path to a local path using the supplied working folder mappings.
A PathTranslation is returned for items that are cloaked, but the
translated item will be null.
serverPath - the server path to translate into a local path (must not be
null or empty)folders - the WorkingFolder mappings to translate with; can be
arranged in any order (must not be null)interpretOneLevelMappingsNormally - if true working folder mappings with
RecursionType.ONE_LEVEL are interpreted normally, if
false WorkingFolder objects with
RecursionType.ONE_LEVEL recursion types are interpreted as
having RecursionType.FULL (useful for some UI methods
which want to predict mapping locations even though an item may be
too far below a one-level to be property considered "mapped")
PathTranslation with the translation information (
PathTranslation.getTranslatedPath() is null
for cloaked items), or null if no appropriate
working folder mapping was found
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||