microsoft.exchange.webservices.data.property.definition

Class IndexedPropertyDefinition

java.lang.Object

microsoft.exchange.webservices.data.property.definition.PropertyDefinitionBase

microsoft.exchange.webservices.data.property.definition.ServiceObjectPropertyDefinition

microsoft.exchange.webservices.data.property.definition.IndexedPropertyDefinition

public final class IndexedPropertyDefinition
extends ServiceObjectPropertyDefinition

Represents an indexed property definition.

Constructor Summary

Constructors

Constructor and Description
IndexedPropertyDefinition(String uri, String index) Initializes a new instance of the IndexedPropertyDefinition class.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Determines whether a given indexed property definition is equal to this indexed property definition.
String	getIndex() Gets the index of the property.
String	getPrintableName() Gets the property definition's printable name.
Class<String>	getType() Gets the property type.
protected String	getXmlElementName() Gets the name of the XML element.
int	hashCode() Serves as a hash function for a particular type.
protected static boolean	isEqualTo(IndexedPropertyDefinition idxPropDef1, IndexedPropertyDefinition idxPropDef2) Determines whether two specified instances of IndexedPropertyDefinition are equal.
protected void	writeAttributesToXml(EwsServiceXmlWriter writer) Writes the attribute to XML.

Methods inherited from class microsoft.exchange.webservices.data.property.definition.ServiceObjectPropertyDefinition

getUri, getVersion

Methods inherited from class microsoft.exchange.webservices.data.property.definition.PropertyDefinitionBase

toString, tryLoadFromXml, writeToXml

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IndexedPropertyDefinition

public IndexedPropertyDefinition(String uri,
                                 String index)

Initializes a new instance of the IndexedPropertyDefinition class.

Parameters:

uri - The FieldURI attribute of the IndexedFieldURI element.

index - The Index attribute of the IndexedFieldURI element.

Method Detail

isEqualTo

protected static boolean isEqualTo(IndexedPropertyDefinition idxPropDef1,
                                   IndexedPropertyDefinition idxPropDef2)

Determines whether two specified instances of IndexedPropertyDefinition are equal.

Parameters:

idxPropDef1 - First indexed property definition.

idxPropDef2 - Second indexed property definition.

Returns:

True if indexed property definitions are equal.

getIndex

public String getIndex()

Gets the index of the property.

Returns:

The index string of the property.

writeAttributesToXml

protected void writeAttributesToXml(EwsServiceXmlWriter writer)
                             throws ServiceXmlSerializationException

Writes the attribute to XML.

Overrides:

writeAttributesToXml in class ServiceObjectPropertyDefinition

Parameters:

writer - the writer

Throws:

ServiceXmlSerializationException - the service xml serialization exception

getXmlElementName

protected String getXmlElementName()

Gets the name of the XML element.

Overrides:

getXmlElementName in class ServiceObjectPropertyDefinition

Returns:

XML element name.

getPrintableName

public String getPrintableName()

Gets the property definition's printable name.

Specified by:

getPrintableName in class PropertyDefinitionBase

Returns:

The property definition's printable name.

equals

public boolean equals(Object obj)

Determines whether a given indexed property definition is equal to this indexed property definition.

Overrides:

equals in class Object

Parameters:

obj - The object to check for equality.

Returns:

True if the property definitions define the same indexed property.

hashCode

public int hashCode()

Serves as a hash function for a particular type.

Overrides:

hashCode in class Object

Returns:

A hash code for the current System.Object

getType

public Class<String> getType()

Gets the property type.

Specified by:

getType in class PropertyDefinitionBase