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

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

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

Holds additional information about a version control item or changeset. Property value names should be compared case-insensitive.

Since:
TEE-SDK-10.1
Thread-safety:
thread-compatible

Field Summary
 
Fields inherited from class com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper
webServiceObject
 
Constructor Summary
PropertyValue(ms.tfs.versioncontrol.clientservices._03._PropertyValue webServiceObject)
          Creates a PropertyValue from a web service object.
PropertyValue(java.lang.String name, java.lang.Object value)
          Creates a PropertyValue with the given name and Object value.
 
Method Summary
static int comparePropertyNames(java.lang.String name1, java.lang.String name2)
           
 boolean equals(java.lang.Object o)
           
 java.lang.String getPropertyName()
           
 java.lang.Class<?> getPropertyType()
           
 java.lang.Object getPropertyValue()
           
 ms.tfs.versioncontrol.clientservices._03._PropertyValue getWebServiceObject()
          Gets the web service object this class wraps.
 int hashCode()
           
 boolean isDirty()
           
 boolean matchesName(java.lang.String propertyName)
          Tests whether this PropertyValue's name matches the specified name.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PropertyValue

public PropertyValue(java.lang.String name,
                     java.lang.Object value)
Creates a PropertyValue with the given name and Object value. The value type must be serializable via the informal XSD/XSI serializer used by XMLStreamWriterHelper.writeElement(javax.xml.stream.XMLStreamWriter, String, Object) .

Parameters:
name - the property name (must not be null or empty)
value - the value object (may be null)

PropertyValue

public PropertyValue(ms.tfs.versioncontrol.clientservices._03._PropertyValue webServiceObject)
Creates a PropertyValue from a web service object.

Parameters:
webServiceObject - the web service object (must not be null)
Method Detail

matchesName

public boolean matchesName(java.lang.String propertyName)
Tests whether this PropertyValue's name matches the specified name. Names are compared case-insensitive.

Parameters:
propertyName - the name to match (may be null)
Returns:
true if the names match, false if the names do not match (possibly because the specified name was null)

comparePropertyNames

public static int comparePropertyNames(java.lang.String name1,
                                       java.lang.String name2)

equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper

hashCode

public int hashCode()
Overrides:
hashCode in class com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper

getWebServiceObject

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

Returns:
the web service object this class wraps.

getPropertyName

public java.lang.String getPropertyName()
Returns:
the name of this property

getPropertyValue

public java.lang.Object getPropertyValue()
Returns:
the object stored as the value for this property

getPropertyType

public java.lang.Class<?> getPropertyType()
Returns:
the type of the property value

isDirty

public boolean isDirty()
Returns:
true if the property value was set during construction, false if it has not been modified

toString

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


© 2015 Microsoft. All rights reserved.