microsoft.exchange.webservices.data.property.complex

Class DictionaryProperty<TKey,TEntry extends DictionaryEntryProperty<TKey>>

java.lang.Object

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

microsoft.exchange.webservices.data.property.complex.DictionaryProperty<TKey,TEntry>

Type Parameters:

TKey - the generic type

TEntry - the generic type

All Implemented Interfaces:

ICustomXmlUpdateSerializer, ISelfValidate, ComplexFunctionDelegate<EwsServiceXmlReader>, IComplexPropertyChangedDelegate<TEntry>

Direct Known Subclasses:

EmailAddressDictionary, ImAddressDictionary, PhoneNumberDictionary, PhysicalAddressDictionary

public abstract class DictionaryProperty<TKey,TEntry extends DictionaryEntryProperty<TKey>>
extends ComplexProperty
implements ICustomXmlUpdateSerializer, IComplexPropertyChangedDelegate<TEntry>

Represents a generic dictionary that can be sent to or retrieved from EWS. TKey The type of key. TEntry The type of entry.

Constructor Summary

Constructors

Constructor and Description
DictionaryProperty()

Method Summary

Modifier and Type	Method and Description
void	clearChangeLog() Clears the change log.
void	complexPropertyChanged(TEntry complexProperty) Complex property changed.
boolean	contains(TKey key) Determines whether this instance contains the specified key.
protected TEntry	createEntry(EwsServiceXmlReader reader) Creates the entry.
protected abstract TEntry	createEntryInstance() Creates instance of dictionary entry.
protected Map<TKey,TEntry>	getEntries() Gets the entries.
protected String	getEntryXmlElementName(TEntry entry) Gets the name of the entry XML element.
protected String	getFieldIndex(TKey key) Gets the index of the field.
protected String	getFieldURI() Gets the field URI.
protected void	internalAdd(TEntry entry) Add entry.
protected void	internalAddOrReplace(TEntry entry) Add or replace entry.
protected void	internalRemove(TKey key) Remove entry based on key.
void	loadFromXml(EwsServiceXmlReader reader, String localElementName) Loads from XML.
boolean	writeDeleteUpdateToXml(EwsServiceXmlWriter writer, ServiceObject ewsObject) Writes deletion update to XML.
void	writeElementsToXml(EwsServiceXmlWriter writer) Writes elements to XML.
boolean	writeSetUpdateToXml(EwsServiceXmlWriter writer, ServiceObject ewsObject, PropertyDefinition propertyDefinition) Writes updates to XML.
void	writeToXml(EwsServiceXmlWriter writer, XmlNamespace xmlNamespace, String xmlElementName) Writes to XML.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

DictionaryProperty

public DictionaryProperty()

Method Detail

getFieldIndex

protected String getFieldIndex(TKey key)

Gets the index of the field.

Parameters:

key - the key

Returns:

Key index.

getFieldURI

protected String getFieldURI()

Gets the field URI.

Returns:

Field URI.

createEntry

protected TEntry createEntry(EwsServiceXmlReader reader)

Creates the entry.

Parameters:

reader - the reader

Returns:

Dictionary entry.

createEntryInstance

protected abstract TEntry createEntryInstance()

Creates instance of dictionary entry.

Returns:

New instance.

getEntryXmlElementName

protected String getEntryXmlElementName(TEntry entry)

Gets the name of the entry XML element.

Parameters:

entry - the entry

Returns:

XML element name.

clearChangeLog

public void clearChangeLog()

Clears the change log.

Overrides:

clearChangeLog in class ComplexProperty

internalAdd

protected void internalAdd(TEntry entry)

Add entry.

Parameters:

entry - the entry

complexPropertyChanged

public void complexPropertyChanged(TEntry complexProperty)

Complex property changed.

Specified by:

complexPropertyChanged in interface IComplexPropertyChangedDelegate<TEntry extends DictionaryEntryProperty<TKey>>

Parameters:

complexProperty - accepts ComplexProperty

internalAddOrReplace

protected void internalAddOrReplace(TEntry entry)

Add or replace entry.

Parameters:

entry - the entry

internalRemove

protected void internalRemove(TKey key)

Remove entry based on key.

Parameters:

key - the key

loadFromXml

public void loadFromXml(EwsServiceXmlReader reader,
                        String localElementName)
                 throws Exception

Loads from XML.

Overrides:

loadFromXml in class ComplexProperty

Parameters:

reader - the reader

localElementName - the local element name

Throws:

Exception - the exception

writeToXml

public void writeToXml(EwsServiceXmlWriter writer,
                       XmlNamespace xmlNamespace,
                       String xmlElementName)
                throws Exception

Writes to XML.

Overrides:

writeToXml in class ComplexProperty

Parameters:

writer - The writer

xmlNamespace - The XML namespace.

xmlElementName - Name of the XML element.

Throws:

Exception

writeElementsToXml

public void writeElementsToXml(EwsServiceXmlWriter writer)
                        throws Exception

Writes elements to XML.

Overrides:

writeElementsToXml in class ComplexProperty

Parameters:

writer - the writer

Throws:

Exception - the exception

getEntries

protected Map<TKey,TEntry> getEntries()

Gets the entries.

Returns:

The entries.

contains

public boolean contains(TKey key)

Determines whether this instance contains the specified key.

Parameters:

key - the key

Returns:

true if this instance contains the specified key; otherwise, false.

writeSetUpdateToXml

public boolean writeSetUpdateToXml(EwsServiceXmlWriter writer,
                                   ServiceObject ewsObject,
                                   PropertyDefinition propertyDefinition)
                            throws Exception

Writes updates to XML.

Specified by:

writeSetUpdateToXml in interface ICustomXmlUpdateSerializer

Parameters:

writer - the writer

ewsObject - the ews object

propertyDefinition - the property definition

Returns:

True if property generated serialization.

Throws:

Exception - the exception

writeDeleteUpdateToXml

public boolean writeDeleteUpdateToXml(EwsServiceXmlWriter writer,
                                      ServiceObject ewsObject)

Writes deletion update to XML.

Specified by:

writeDeleteUpdateToXml in interface ICustomXmlUpdateSerializer

Parameters:

writer - the writer

ewsObject - the ews object

Returns:

True if property generated serialization.