Package microsoft.exchange.webservices.data.property.complex

Class DictionaryEntryProperty<TKey>

java.lang.Object

microsoft.exchange.webservices.data.property.complex.ComplexProperty

microsoft.exchange.webservices.data.property.complex.DictionaryEntryProperty<TKey>

Type Parameters:

TKey - the generic type

All Implemented Interfaces:

ISelfValidate, ComplexFunctionDelegate<EwsServiceXmlReader>

Direct Known Subclasses:

EmailAddressEntry, ImAddressEntry, PhoneNumberEntry, PhysicalAddressEntry

public abstract class DictionaryEntryProperty<TKey>
extends ComplexProperty

Represents an entry of a DictionaryProperty object. All descendants of DictionaryEntryProperty must implement a parameterless constructor. That constructor does not have to be public. That constructor does not have to be public.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DictionaryEntryProperty(Class<TKey> cls)	Initializes a new instance of the "DictionaryEntryProperty<TKey>" class.
protected	DictionaryEntryProperty(Class<TKey> cls, TKey key)	Initializes a new instance of the "DictionaryEntryProperty<TKey>" class.

Method Summary

Modifier and Type	Method	Description
protected TKey	getKey()	Gets the key.
void	readAttributesFromXml(EwsServiceXmlReader reader)	Reads the attribute from XML.
protected void	setKey(TKey value)	Sets the key.
void	writeAttributesToXml(EwsServiceXmlWriter writer)	Writes the attribute to XML.
protected boolean	writeDeleteUpdateToXml(EwsServiceXmlWriter writer, ServiceObject ewsObject)	Writes the delete update to XML.
protected boolean	writeSetUpdateToXml(EwsServiceXmlWriter writer, ServiceObject ewsObject, String ownerDictionaryXmlElementName)	Writes the set update to XML.

Methods inherited from class microsoft.exchange.webservices.data.property.complex.ComplexProperty

addOnChangeEvent, canSetFieldValue, changed, clearChangeEvents, clearChangeLog, func, getNamespace, internalValidate, loadFromXml, loadFromXml, readTextValueFromXml, removeChangeEvent, setNamespace, tryReadElementFromXml, tryReadElementFromXmlToPatch, updateFromXml, updateFromXml, validate, writeElementsToXml, writeToXml, writeToXml

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DictionaryEntryProperty

protected DictionaryEntryProperty(Class<TKey> cls)

Initializes a new instance of the "DictionaryEntryProperty<TKey>" class.

DictionaryEntryProperty

protected DictionaryEntryProperty(Class<TKey> cls,
                                  TKey key)

Initializes a new instance of the "DictionaryEntryProperty<TKey>" class.

Parameters:

key - The key.

Method Detail

getKey

protected TKey getKey()

Gets the key.

Returns:

the key

setKey

protected void setKey(TKey value)

Sets the key.

Parameters:

value - the value to set

readAttributesFromXml

public void readAttributesFromXml(EwsServiceXmlReader reader)
                           throws Exception

Reads the attribute from XML.

Overrides:

readAttributesFromXml in class ComplexProperty

Parameters:

reader - accepts EwsServiceXmlReader

Throws:

Exception - throws Exception

writeAttributesToXml

public void writeAttributesToXml(EwsServiceXmlWriter writer)
                          throws ServiceXmlSerializationException

Writes the attribute to XML.

Overrides:

writeAttributesToXml in class ComplexProperty

Parameters:

writer - accepts EwsServiceXmlWriter

Throws:

ServiceXmlSerializationException - throws ServiceXmlSerializationException

writeSetUpdateToXml

protected boolean writeSetUpdateToXml(EwsServiceXmlWriter writer,
                                      ServiceObject ewsObject,
                                      String ownerDictionaryXmlElementName)
                               throws XMLStreamException,
                                      ServiceXmlSerializationException

Writes the set update to XML.

Parameters:

writer - the writer

ewsObject - the ews object

ownerDictionaryXmlElementName - name of the owner dictionary XML element

Returns:

true if update XML was written

Throws:

XMLStreamException - the XML stream exception

ServiceXmlSerializationException - the service xml serialization exception

writeDeleteUpdateToXml

protected boolean writeDeleteUpdateToXml(EwsServiceXmlWriter writer,
                                         ServiceObject ewsObject)
                                  throws XMLStreamException,
                                         ServiceXmlSerializationException

Writes the delete update to XML.

Parameters:

writer - the writer

ewsObject - the ews object

Returns:

true if update XML was written

Throws:

XMLStreamException - the XML stream exception

ServiceXmlSerializationException - the service xml serialization exception