microsoft.exchange.webservices.data.ComplexPropertyCollection Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of exchange-ws-api Show documentation
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="ComplexPropertyCollection.java" company="Microsoft"
* Copyright (c) Microsoft Corporation. All rights reserved.
*
* Defines the ComplexPropertyCollection.java.
**************************************************************************/
package microsoft.exchange.webservices.data;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
/***
* Represents a collection of properties that can be sent to and retrieved from
* EWS.
*
*
* @param
* ComplexProperty type.
*/
@EditorBrowsable(state = EditorBrowsableState.Never)
public abstract class ComplexPropertyCollection
extends ComplexProperty implements ICustomXmlUpdateSerializer,
Iterable, IComplexPropertyChangedDelegate {
/** The items. */
private List items = new ArrayList();
/** The added items. */
private List addedItems =
new ArrayList();
/** The modified items. */
private List modifiedItems =
new ArrayList();
/** The removed items. */
private List removedItems =
new ArrayList();
/***
* Creates the complex property.
*
* @param xmlElementName
* Name of the XML element.
* @return Complex property instance.
*/
protected abstract TComplexProperty createComplexProperty(
String xmlElementName);
/***
* Gets the name of the collection item XML element.
*
* @param complexProperty
* The complex property.
* @return XML element name.
*/
protected abstract String getCollectionItemXmlElementName(
TComplexProperty complexProperty);
/**
* Initializes a new instance of. ComplexPropertyCollection
*/
protected ComplexPropertyCollection() {
super();
}
/***
* Item changed.
*
* @param complexProperty
* The complex property.
*/
protected void itemChanged(ComplexProperty complexProperty) {
EwsUtilities.EwsAssert(complexProperty instanceof ComplexProperty,
"ComplexPropertyCollection.ItemChanged", String.format(
"ComplexPropertyCollection." +
"ItemChanged: the type of " +
"the complexProperty " + "argument " +
"(%s) is not supported.",
complexProperty.getClass().getName()));
TComplexProperty property = (TComplexProperty)complexProperty;
if (!this.addedItems.contains(property)) {
if (!this.modifiedItems.contains(property)) {
this.modifiedItems.add(property);
this.changed();
}
}
}
/**
* Loads from XML.
* @param reader The reader.
* @param localElementName Name of the local element.
*/
@Override
protected void loadFromXml(EwsServiceXmlReader reader,
String localElementName) throws Exception {
this.loadFromXml(
reader,
XmlNamespace.Types,
localElementName);
}
/**
* Loads from XML.
* @param reader The reader.
* @param xmlNamespace The XML namespace.
* @param localElementName Name of the local element.
*/
@Override
protected void loadFromXml(EwsServiceXmlReader reader,
XmlNamespace xmlNamespace,
String localElementName) throws Exception {
reader.ensureCurrentNodeIsStartElement(xmlNamespace,
localElementName);
if (!reader.isEmptyElement()) {
do {
reader.read();
if (reader.isStartElement()) {
TComplexProperty complexProperty = this
.createComplexProperty(reader.getLocalName());
if (complexProperty != null) {
complexProperty.loadFromXml(reader, reader
.getLocalName());
this.internalAdd(complexProperty, true);
} else {
reader.skipCurrentElement();
}
}
} while (!reader.isEndElement(xmlNamespace, localElementName));
} else {
reader.read();
}
}
/**
* Writes to XML.
* @param writer The writer.
* @param xmlNamespace The XML namespace.
* @param xmlElementName Name of the XML element.
*/
@Override
protected void writeToXml(EwsServiceXmlWriter writer,
XmlNamespace xmlNamespace,
String xmlElementName) throws Exception {
if (this.shouldWriteToXml()) {
super.writeToXml(
writer,
xmlNamespace,
xmlElementName);
}
}
/**
* Determine whether we should write collection to XML or not.
* @return True if collection contains at least one element.
*/
protected boolean shouldWriteToXml() {
//Only write collection if it has at least one element.
return this.getCount() > 0;
}
/**
* * Writes elements to XML.
*
* @param writer
* The writer.
* @throws Exception
* the exception
*/
@Override
protected void writeElementsToXml(EwsServiceXmlWriter writer)
throws Exception {
for (TComplexProperty complexProperty : this) {
complexProperty.writeToXml(writer, this
.getCollectionItemXmlElementName(complexProperty));
}
}
/***
* Clears the change log.
*/
@Override
protected void clearChangeLog() {
this.removedItems.clear();
this.addedItems.clear();
this.modifiedItems.clear();
}
/***
* Removes from change log.
*
* @param complexProperty
* The complex property.
*/
protected void removeFromChangeLog(TComplexProperty complexProperty) {
this.removedItems.remove(complexProperty);
this.modifiedItems.remove(complexProperty);
this.addedItems.remove(complexProperty);
}
/***
* Gets the items.
*
* @return The items.
*/
protected List getItems() {
return this.items;
}
/***
* Gets the added items.
*
* @return The added items.
*/
protected List getAddedItems() {
return this.addedItems;
}
/***
* Gets the modified items.
*
* @return The modified items.
*/
protected List getModifiedItems() {
return this.modifiedItems;
}
/***
* Gets the removed items.
*
* @return The removed items.
*/
protected List getRemovedItems() {
return this.removedItems;
}
/***
* Add complex property.
*
* @param complexProperty
* The complex property.
*/
protected void internalAdd(TComplexProperty complexProperty) {
this.internalAdd(complexProperty, false);
}
/***
* Add complex property.
*
* @param complexProperty
* The complex property.
* @param loading
* If true, collection is being loaded.
*/
private void internalAdd(TComplexProperty complexProperty,
boolean loading) {
EwsUtilities.EwsAssert(complexProperty != null,
"ComplexPropertyCollection.InternalAdd",
"complexProperty is null");
if (!this.items.contains(complexProperty)) {
this.items.add(complexProperty);
if (!loading) {
this.removedItems.remove(complexProperty);
this.addedItems.add(complexProperty);
}
complexProperty.addOnChangeEvent(this);
this.changed();
}
}
/**
* Complex property changed.
*
* @param complexProperty
* accepts ComplexProperty
*/
@Override
public void complexPropertyChanged(ComplexProperty complexProperty) {
this.itemChanged(complexProperty);
}
/***
* Clear collection.
*/
protected void internalClear() {
while (this.getCount() > 0) {
this.internalRemoveAt(0);
}
}
/***
* Remote entry at index.
*
* @param index
* The index.
*/
protected void internalRemoveAt(int index) {
EwsUtilities.EwsAssert(index >= 0 && index < this.getCount(),
"ComplexPropertyCollection.InternalRemoveAt",
"index is out of range.");
this.internalRemove(this.items.get(index));
}
/***
* Remove specified complex property.
*
* @param complexProperty
* The complex property.
* @return True if the complex property was successfully removed from the
* collection, false otherwise.
*/
protected boolean internalRemove(TComplexProperty complexProperty) {
EwsUtilities.EwsAssert(complexProperty != null,
"ComplexPropertyCollection.InternalRemove",
"complexProperty is null");
if (this.items.remove(complexProperty)) {
complexProperty.removeChangeEvent(this);
if (!this.addedItems.contains(complexProperty)) {
this.removedItems.add(complexProperty);
} else {
this.addedItems.remove(complexProperty);
}
this.modifiedItems.remove(complexProperty);
this.changed();
return true;
} else {
return false;
}
}
/***
* Determines whether a specific property is in the collection.
*
* @param complexProperty
* The property to locate in the collection.
* @return True if the property was found in the collection, false
* otherwise.
*/
public boolean contains(TComplexProperty complexProperty) {
return this.items.contains(complexProperty);
}
/***
* Searches for a specific property and return its zero-based index within
* the collection.
*
* @param complexProperty
* The property to locate in the collection.
* @return The zero-based index of the property within the collection.
*/
public int indexOf(TComplexProperty complexProperty) {
return this.items.indexOf(complexProperty);
}
/**
* * Gets the total number of properties in the collection.
*
* @return the count
*/
public int getCount() {
return this.items.size();
}
/**
* * Gets the property at the specified index.
*
* @param index
* the index
* @return index The property at the specified index.
* @throws IllegalArgumentException
* thrown if if index is out of range.
*/
public TComplexProperty getPropertyAtIndex(int index)
throws IllegalArgumentException {
if (index < 0 || index >= this.getCount()) {
throw new IllegalArgumentException("parameter \'index\' : " +
Strings.IndexIsOutOfRange);
}
return this.items.get(index);
}
/***
* Gets an enumerator that iterates through the elements of the collection.
*
* @return An Iterator for the collection.
*/
@Override
public Iterator iterator() {
return this.items.iterator();
}
/**
* Write set update to xml.
*
* @param writer
* accepts EwsServiceXmlWriter
* @param ewsObject
* accepts ServiceObject
* @param propertyDefinition
* accepts PropertyDefinition
* @return true
* @throws Exception
* the exception
*/
@Override
public boolean writeSetUpdateToXml(EwsServiceXmlWriter writer,
ServiceObject ewsObject, PropertyDefinition propertyDefinition)
throws Exception {
// If the collection is empty, delete the property.
if (this.getCount() == 0) {
writer.writeStartElement(XmlNamespace.Types, ewsObject
.getDeleteFieldXmlElementName());
propertyDefinition.writeToXml(writer);
writer.writeEndElement();
return true;
}
// Otherwise, use the default XML serializer.
else {
return false;
}
}
/**
* * Writes the deletion update to XML.
*
* @param writer
* The writer.
* @param ewsObject
* The ews object.
* @return True if property generated serialization.
* @throws Exception
* the exception
*/
@Override
public boolean writeDeleteUpdateToXml(EwsServiceXmlWriter writer,
ServiceObject ewsObject) throws Exception {
// Use the default XML serializer.
return false;
}
}