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

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

public class FileType
extends com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper

Represents a single server-registered file type. It has a name, an associated list of file extensions which define names which match this type, and a boolean indicating whether the file can be checked out non-exclusively.

Since:
TEE-SDK-10.1

Field Summary
 
Fields inherited from class com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper
webServiceObject
 
Constructor Summary
FileType(ms.tfs.versioncontrol.clientservices._03._FileType fileType)
          Construct an AFileType given a soap-returned FileType object.
FileType()
          Construct a new, empty FileType, with a null name and no associated extensions.
 
Method Summary
 java.lang.String getDisplayExtensions()
          Gets the list of associated extensions for this file type, suitable for displaying only.
 java.lang.String getEditingExtensions()
          Gets the list of associated extensions for this file type, suitable for editing.
 java.util.List<java.lang.String> getExtensions()
          Gets the list of associated extensions for this file type in a List form
 java.lang.String getName()
           
 ms.tfs.versioncontrol.clientservices._03._FileType getWebServiceObject()
          Gets the web service object this class wraps.
 boolean isAllowMultipleCheckout()
           
 void setAllowMultipleCheckout(boolean allowMultipleCheckout)
          Sets whether this file type allows multiple check-outs.
 void setEditingExtensions(java.lang.String s)
          Sets the associated extensions for this file type.
 void setName(java.lang.String name)
          Set the name of this file type.
 java.lang.String toString()
           
 
Methods inherited from class com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper
equals, hashCode
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

FileType

public FileType()
Construct a new, empty FileType, with a null name and no associated extensions.


FileType

public FileType(ms.tfs.versioncontrol.clientservices._03._FileType fileType)
Construct an AFileType given a soap-returned FileType object. All attributes of the new AFileType object are driven from the FileType object.

Parameters:
fileType -
Method Detail

getWebServiceObject

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

Returns:
the web service object this class wraps.

getName

public java.lang.String getName()
Returns:
the descriptive name of this file type

getExtensions

public java.util.List<java.lang.String> getExtensions()
Gets the list of associated extensions for this file type in a List form

Returns:
list of extensions

getDisplayExtensions

public java.lang.String getDisplayExtensions()
Gets the list of associated extensions for this file type, suitable for displaying only. The extensions will be returned as a semicolon separated list of strings.

Returns:
list of associated extensions for display purposes

getEditingExtensions

public java.lang.String getEditingExtensions()
Gets the list of associated extensions for this file type, suitable for editing. After modification, the returned String can be passed back to this object by calling setEditingExtensions(). The extensions will be returned as a semicolon separated list of strings, each with a *. prepended to it.

Returns:
list of associated extensions for editing purposes

setEditingExtensions

public void setEditingExtensions(java.lang.String s)
Sets the associated extensions for this file type. The given string can be comprised of a single extension or multiple extensions. If multiple, the extensions must be separated by either commas or semicolons. Whitespace surrounding extensions is ignored, and a leading *. if present will be stripped from each extension. The following are all valid inputs to this method: txt *.txt txt, bat, *exe *.txt; *.bat, *.exe

Parameters:
s - extensions to set

isAllowMultipleCheckout

public boolean isAllowMultipleCheckout()
Returns:
true if the file type allows multiple check-outs.

setAllowMultipleCheckout

public void setAllowMultipleCheckout(boolean allowMultipleCheckout)
Sets whether this file type allows multiple check-outs.

Parameters:
allowMultipleCheckout - true if this file type should allow multiple check-outs.

setName

public void setName(java.lang.String name)
Set the name of this file type.

Parameters:
name - name to use

toString

public java.lang.String toString()
Overrides:
toString in class com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper


© 2015 Microsoft. All rights reserved.