• Home
• com.microsoft.ewsjavaapi
• exchange-ws-api
• 1.1.5.2
• source code
• PropertyBag.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

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

/**************************************************************************
 * copyright file="PropertyBag.java" company="Microsoft"
 *     Copyright (c) Microsoft Corporation.  All rights reserved.
 * 
 * Defines the PropertyBag.java.
 **************************************************************************/
package microsoft.exchange.webservices.data;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;

/***
 * Represents a property bag keyed on PropertyDefinition objects.
 */
class PropertyBag implements IComplexPropertyChanged,
		IComplexPropertyChangedDelegate {

	/** The owner. */
	private ServiceObject owner;

	/** The is dirty. */
	private boolean isDirty;

	/** The loading. */
	private boolean loading;
	
	/** The only summary properties requested. */
	private boolean onlySummaryPropertiesRequested;

	/** The loaded properties. */
	private List loadedProperties = 
		new ArrayList();

	/** The properties. */
	private Map properties = 
		new HashMap();

	/** The deleted properties. */
	private Map deletedProperties =
		new HashMap();

	/** The modified properties. */
	private List modifiedProperties = 
		new ArrayList();

	/** The added properties. */
	private List addedProperties =
		new ArrayList();

	/** The requested property set. */
	private PropertySet requestedPropertySet;

	/***
	 * Initializes a new instance of PropertyBag.
	 * 
	 * @param owner
	 *            The owner of the bag.
	 */
	protected PropertyBag(ServiceObject owner) {
		EwsUtilities.EwsAssert(owner != null, "PropertyBag.ctor",
				"owner is null");

		this.owner = owner;
	}

	/***
	 * Gets a Map holding the bag's properties.
	 * 
	 * @return A Map holding the bag's properties.
	 */
	protected Map getProperties() {
		return this.properties;
	}

	/***
	 * Gets the owner of this bag.
	 * 
	 * @return The owner of this bag.
	 */
	protected ServiceObject getOwner() {
		return this.owner;
	}

	/***
	 * Indicates if a bag has pending changes.
	 * 
	 * @return True if the bag has pending changes, false otherwise.
	 */
	protected boolean getIsDirty() {
		int changes = this.modifiedProperties.size() +
				 this.deletedProperties.size() + this.addedProperties.size();
		return changes > 0 || this.isDirty;
	}

	/***
	 * Adds the specified property to the specified change list if it is not
	 * already present.
	 * 
	 * @param propertyDefinition
	 *            The property to add to the change list.
	 * @param changeList
	 *            The change list to add the property to.
	 */
	protected static void addToChangeList(
			PropertyDefinition propertyDefinition,
			List changeList) {
		if (!changeList.contains(propertyDefinition)) {
			changeList.add(propertyDefinition);
		}
	}
	
	/**
	 * Checks if is property loaded.
	 * 
	 * @param propertyDefinition
	 *            the property definition
	 * @return true, if is property loaded
	 */
	protected boolean isPropertyLoaded(PropertyDefinition propertyDefinition) {
		// Is the property loaded?
		if (this.loadedProperties.contains(propertyDefinition)) {
			return true;
		} else {
			// Was the property requested?
			return this.isRequestedProperty(propertyDefinition);
		}
	}

	/**
	 * Checks if is requested property.
	 * 
	 * @param propertyDefinition
	 *            the property definition
	 * @return true, if is requested property
	 */
	private boolean isRequestedProperty(PropertyDefinition propertyDefinition) {
		// If no requested property set, then property wasn't requested.
		if (this.requestedPropertySet == null) {
			return false;
		}

		// If base property set is all first-class properties, use the
		// appropriate list of
		// property definitions to see if this property was requested.
		// Otherwise, property had
		// to be explicitly requested and needs to be listed in
		// AdditionalProperties.
		if (this.requestedPropertySet.getBasePropertySet() == BasePropertySet.FirstClassProperties) {
			List firstClassProps = 
				this.onlySummaryPropertiesRequested ? this
					.getOwner().getSchema().getFirstClassSummaryProperties() :
					 this.getOwner().getSchema().getFirstClassProperties();

			return firstClassProps.contains(propertyDefinition) ||
					 this.requestedPropertySet.contains(propertyDefinition);
		} else {
			return this.requestedPropertySet.contains(propertyDefinition);
		}
	}

	/***
	 * Determines whether the specified property has been updated.
	 * 
	 * @param propertyDefinition
	 *            The property definition.
	 * @return true if the specified property has been updated; otherwise,
	 *         false.
	 */
	protected boolean isPropertyUpdated(PropertyDefinition propertyDefinition) {
		return this.modifiedProperties.contains(propertyDefinition) ||
				 this.addedProperties.contains(propertyDefinition);
	}

	/***
	 * Tries to get a property value based on a property definition.
	 * 
	 * @param propertyDefinition
	 *            The property definition.
	 * @param propertyValueOutParam
	 *            The property value.
	 * @return True if property was retrieved.
	 */
	protected boolean tryGetProperty(PropertyDefinition propertyDefinition,
			OutParam