microsoft.exchange.webservices.data
Class UserConfigurationDictionary

java.lang.Object
  microsoft.exchange.webservices.data.ComplexProperty
      microsoft.exchange.webservices.data.UserConfigurationDictionary

All Implemented Interfaces:

Iterable<Object>

public final class UserConfigurationDictionary
extends ComplexProperty
implements Iterable<Object>

Represents a user configuration's Dictionary property.

Constructor Summary

protected

UserConfigurationDictionary() Initializes a new instance of "UserConfigurationDictionary" class.

Method Summary

void	addElement(Object key, Object value) Adds an element with the provided key and value to the user configuration dictionary.
protected void	changed() Instance was changed.
void	clear() Removes all items from the user configuration dictionary.
boolean	containsKey(Object key) Determines whether the user configuration dictionary contains an element with the specified key.
int	getCount() Gets the number of elements in the user configuration dictionary.
Object	getElements(Object key) Gets the element with the specified key.
Iterator	getEnumerator() Gets the enumerator.
protected boolean	getIsDirty() Gets the isDirty flag.
Iterator<Object>	iterator()
protected void	loadFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader, microsoft.exchange.webservices.data.XmlNamespace xmlNamespace, String xmlElementName) * Loads from XML.
boolean	remove(Object key) Removes the element with the specified key from the user configuration dictionary.
void	setElements(Object key, Object value) Sets the element with the specified key.
protected void	setIsDirty(boolean value) Sets the isDirty flag.
boolean	tryGetValue(Object key, OutParam<Object> value) Gets the value associated with the specified key.
protected boolean	tryReadElementFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader) * Tries to read element from XML.
protected void	writeElementsToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer) * Writes elements to XML.

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

addOnChangeEvent, canSetFieldValue, clearChangeEvents, clearChangeLog, getNamespace, internalValidate, loadFromXml, readAttributesFromXml, readTextValueFromXml, removeChangeEvent, setNamespace, validate, writeAttributesToXml, writeToXml, writeToXml

Methods inherited from class java.lang.Object

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

Constructor Detail

UserConfigurationDictionary

protected UserConfigurationDictionary()

Initializes a new instance of "UserConfigurationDictionary" class.

Method Detail

getElements

public Object getElements(Object key)

Gets the element with the specified key.

Parameters:

key - The key of the element to get or set.

Returns:

The element with the specified key.

setElements

public void setElements(Object key,
                        Object value)
                 throws Exception

Sets the element with the specified key.

Parameters:

key - The key of the element to get or set

value - the value

Throws:

Exception - the exception

addElement

public void addElement(Object key,
                       Object value)
                throws Exception

Adds an element with the provided key and value to the user configuration dictionary.

Parameters:

key - The object to use as the key of the element to add.

value - The object to use as the value of the element to add.

Throws:

Exception - the exception

containsKey

public boolean containsKey(Object key)

Determines whether the user configuration dictionary contains an element with the specified key.

Parameters:

key - The key to locate in the user configuration dictionary.

Returns:

true if the user configuration dictionary contains an element with the key; otherwise false.

remove

public boolean remove(Object key)

Removes the element with the specified key from the user configuration dictionary.

Parameters:

key - The key of the element to remove.

Returns:

true if the element is successfully removed; otherwise false.

tryGetValue

public boolean tryGetValue(Object key,
                           OutParam<Object> value)

Gets the value associated with the specified key.

Parameters:

key - The key whose value to get.

value - When this method returns, the value associated with the specified key, if the key is found; otherwise, null.

Returns:

true if the user configuration dictionary contains the key; otherwise false.

getCount

public int getCount()

Gets the number of elements in the user configuration dictionary.

Returns:

the count

clear

public void clear()

Removes all items from the user configuration dictionary.

getEnumerator

public Iterator getEnumerator()

Gets the enumerator.

Returns:

the enumerator

getIsDirty

protected boolean getIsDirty()

Gets the isDirty flag.

Returns:

the checks if is dirty

setIsDirty

protected void setIsDirty(boolean value)

Sets the isDirty flag.

Parameters:

value - the new checks if is dirty

changed

protected void changed()

Instance was changed.

Overrides:

changed in class ComplexProperty

writeElementsToXml

protected void writeElementsToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer)
                           throws XMLStreamException,
                                  ServiceXmlSerializationException

* Writes elements to XML.

Overrides:

writeElementsToXml in class ComplexProperty

Parameters:

writer - accepts EwsServiceXmlWriter

Throws:

XMLStreamException - the xML stream exception

ServiceXmlSerializationException - the service xml serialization exception

loadFromXml

protected void loadFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader,
                           microsoft.exchange.webservices.data.XmlNamespace xmlNamespace,
                           String xmlElementName)
                    throws Exception

Description copied from class: ComplexProperty

* Loads from XML.

Overrides:

loadFromXml in class ComplexProperty

Parameters:

reader - The reader.

xmlNamespace - the xml namespace

xmlElementName - Name of the XML element.

Throws:

Exception - the exception

tryReadElementFromXml

protected boolean tryReadElementFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader)
                                 throws Exception

Description copied from class: ComplexProperty

* Tries to read element from XML.

Overrides:

tryReadElementFromXml in class ComplexProperty

Parameters:

reader - The reader.

Returns:

True if element was read.

Throws:

Exception - the exception

iterator

public Iterator<Object> iterator()

Specified by:

iterator in interface Iterable<Object>