microsoft.exchange.webservices.data.DictionaryEntryProperty Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of exchange-ws-api Show documentation
The source came from http://archive.msdn.microsoft.com/ewsjavaapi Support for Maven has been added.
The newest version!
/**************************************************************************
 * copyright file="DictionaryEntryProperty.java" company="Microsoft"
 *     Copyright (c) Microsoft Corporation.  All rights reserved.
 * 
 * Defines the DictionaryEntryProperty.java.
 **************************************************************************/
package microsoft.exchange.webservices.data;

import javax.xml.stream.XMLStreamException;

/**
 * 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.
 * 
 * @param 
 *            the generic type
 */
@EditorBrowsable(state = EditorBrowsableState.Never)
public abstract class DictionaryEntryProperty extends ComplexProperty {

	/** The key. */
	private TKey key;
	private Class instance;

	/**
	 * Initializes a new instance of the "DictionaryEntryProperty<TKey>"
	 * class.
	 * 
	 */
	protected DictionaryEntryProperty(Class cls) {
		this.instance = cls;
	}

	/**
	 * Initializes a new instance of the "DictionaryEntryProperty<TKey>"
	 * class.
	 * 
	 * @param key
	 *            The key.
	 */
	protected DictionaryEntryProperty(Class cls,TKey key) {
		super();
		this.key = key;
		this.instance = cls;
	}

	/**
	 * Gets the key.
	 * 
	 * @return the key
	 */
	protected TKey getKey() {
		return key;
	}

	/**
	 * Sets the key.
	 * 
	 * @param value
	 *            the value to set
	 */
	protected void setKey(TKey value) {
		this.key = value;
	}

	/**
	 * Reads the attributes from XML.
	 * 
	 * @param reader
	 *            accepts EwsServiceXmlReader
	 * @throws Exception
	 *             throws Exception
	 */
	@Override
	protected void readAttributesFromXml(EwsServiceXmlReader reader)
			throws Exception {
		this.key = reader.readAttributeValue(instance,
				XmlAttributeNames.Key);
	}

	/**
	 * Writes the attributes to XML.
	 * 
	 * @param writer
	 *            accepts EwsServiceXmlWriter
	 * @throws ServiceXmlSerializationException
	 *             throws ServiceXmlSerializationException
	 */
	@Override
	protected void writeAttributesToXml(EwsServiceXmlWriter writer)
			throws ServiceXmlSerializationException {
		writer.writeAttributeValue(XmlAttributeNames.Key, this.getKey());
	}

	/**
	 * Writes the set update to XML.
	 * 
	 * @param writer
	 *            The writer.
	 * @param ewsObject
	 *            The ews object.
	 * @param ownerDictionaryXmlElementName
	 *            Name of the owner dictionary XML element.
	 * @return True if update XML was written.
	 * @throws XMLStreamException
	 *             the xML stream exception
	 * @throws ServiceXmlSerializationException
	 *             the service xml serialization exception
	 */
	protected boolean writeSetUpdateToXml(EwsServiceXmlWriter writer,
			ServiceObject ewsObject, String ownerDictionaryXmlElementName)
			throws XMLStreamException, ServiceXmlSerializationException {
		return false;
	}

	/**
	 * Writes the delete update to XML.
	 * 
	 * @param writer
	 *            The writer.
	 * @param ewsObject
	 *            The ews object.
	 * @return True if update XML was written.
	 * @throws XMLStreamException
	 *             the xML stream exception
	 * @throws ServiceXmlSerializationException
	 *             the service xml serialization exception
	 */
	protected boolean writeDeleteUpdateToXml(EwsServiceXmlWriter writer,
			ServiceObject ewsObject) throws XMLStreamException,
			ServiceXmlSerializationException {
		return false;
	}

}