com.microsoft.tfs.core.clients.versioncontrol.exceptions
Class TeamFoundationServerExceptionProperties

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

public class TeamFoundationServerExceptionProperties
extends java.lang.Object

A set of properties returned by various TFS exceptions.

Since:
TEE-SDK-10.1

Constructor Summary
TeamFoundationServerExceptionProperties()
          Constructor.
TeamFoundationServerExceptionProperties(org.w3c.dom.Element exceptionPropertiesElement)
          Constructor.
 
Method Summary
 boolean getBooleanProperty(java.lang.String propertyName)
          Return a boolean value for the specified property name.
 int getIntProperty(java.lang.String propertyName)
          Return an integer value for the specified property name.
 java.lang.Object[] getObjectArrayProperty(java.lang.String propertyName)
          Return an object array for the specified property name.
 java.lang.String[] getStringArrayProperty(java.lang.String propertyName)
          Return a string array value for the specified property name.
 java.lang.String getStringProperty(java.lang.String propertyName)
          Return a string value for the specified property name.
 boolean hasBooleanProperty(java.lang.String propertyName)
          Test for a boolean property with a given name.
 boolean hasIntProperty(java.lang.String propertyName)
          Test for a integer property with a given name.
 boolean hasObjectArrayProperty(java.lang.String propertyName)
          Test for an object array property with the given name.
 boolean hasStringProperty(java.lang.String propertyName)
          Test for a string property with a given name.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TeamFoundationServerExceptionProperties

public TeamFoundationServerExceptionProperties()
Constructor. Creates an empty property set.


TeamFoundationServerExceptionProperties

public TeamFoundationServerExceptionProperties(org.w3c.dom.Element exceptionPropertiesElement)
Constructor.

Parameters:
exceptionPropertiesElement - An XML DOM element which is the root of a properties list.
Method Detail

hasObjectArrayProperty

public boolean hasObjectArrayProperty(java.lang.String propertyName)
Test for an object array property with the given name.

Parameters:
propertyName - The property name.
Returns:
True if the property exists and is an object array.

hasIntProperty

public boolean hasIntProperty(java.lang.String propertyName)
Test for a integer property with a given name.

Parameters:
propertyName - The property name.
Returns:
True if property exists and and is an integer.

hasBooleanProperty

public boolean hasBooleanProperty(java.lang.String propertyName)
Test for a boolean property with a given name.

Parameters:
propertyName - The property name.
Returns:
True if the property exists and is a boolean.

hasStringProperty

public boolean hasStringProperty(java.lang.String propertyName)
Test for a string property with a given name.

Parameters:
propertyName - The property name.
Returns:
True if the property exists and is a string.

getObjectArrayProperty

public java.lang.Object[] getObjectArrayProperty(java.lang.String propertyName)
Return an object array for the specified property name.

Parameters:
propertyName - The property name.
Returns:
The object array or null if the property does not exist.

getBooleanProperty

public boolean getBooleanProperty(java.lang.String propertyName)
Return a boolean value for the specified property name.

Parameters:
propertyName - The property name.
Returns:
The property value as a boolean value or FALSE if the property does not exist

getIntProperty

public int getIntProperty(java.lang.String propertyName)
Return an integer value for the specified property name.

Parameters:
propertyName - The property name.
Returns:
The property value as an integer value or 0 if the property does not exist.

getStringProperty

public java.lang.String getStringProperty(java.lang.String propertyName)
Return a string value for the specified property name.

Parameters:
propertyName - The property name.
Returns:
The property value as a string or null if there is no such property with a string value.

getStringArrayProperty

public java.lang.String[] getStringArrayProperty(java.lang.String propertyName)
Return a string array value for the specified property name.

Parameters:
propertyName - The property name.
Returns:
The property value as a string array which can be empty.


© 2015 Microsoft. All rights reserved.