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

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

public class PathTranslation
extends java.lang.Object

Contains the results of a translation via working folder mapping of a path (server or local) to the other type (local or server). Includes the translated paths as well as information about the mapping which was used for the translation.

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

Constructor Summary
PathTranslation(java.lang.String originalPath, java.lang.String translatedPath, boolean isCloaked, RecursionType recursionType)
          Constructs a PathTranslation.
 
Method Summary
 java.lang.String getOriginalPath()
           
 RecursionType getRecursionType()
           
 java.lang.String getTranslatedPath()
           
 boolean isCloaked()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PathTranslation

public PathTranslation(java.lang.String originalPath,
                       java.lang.String translatedPath,
                       boolean isCloaked,
                       RecursionType recursionType)
Constructs a PathTranslation.

Parameters:
originalPath - the path (server or local) which was translated to the other kind (local or server) (must not be null or empty)
translatedPath - the translated path (server or local). Must not be null or empty if isCloaked is false, otherwise may be null.
isCloaked - true if the mapping used for translation was a cloak mapping, false if it was a normal mapping
recursionType - the recursion type used to perform the mapping (see getRecursionType() for more information)
Method Detail

getOriginalPath

public java.lang.String getOriginalPath()
Returns:
the path before translation (server or local). Never null.

getTranslatedPath

public java.lang.String getTranslatedPath()
Returns:
the path after translation (server or local). May be null when isCloaked() returns true, otherwise never null (required to support a translation of a server path to a local path in a cloaked mapping).

isCloaked

public boolean isCloaked()
Returns:
true if the WorkingFolder mapping used to translate the path was a cloak mapping, false if it was a non-cloak mapping

getRecursionType

public RecursionType getRecursionType()
Returns:
the RecursionType of the working folder mapping used to translate the path. Always RecursionType.NONE for items mapped inside a RecursionType.ONE_LEVEL mapping, otherwise the WorkingFolder's mapping.


© 2015 Microsoft. All rights reserved.