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

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

import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;

/**
 * * Represents a collection of changes as returned by a synchronization
 * operation.
 * 
 * @param 
 *            the generic type
 */
public final class ChangeCollection implements
		Iterable {

	/** The changes. */
	private List changes = new ArrayList();

	/** The sync state. */
	private String syncState;

	/** The more changes available. */
	private boolean moreChangesAvailable;

	/**
	 * * Initializes a new instance of the class.
	 */
	protected ChangeCollection() {
	}

	/**
	 * * Adds the specified change.
	 * 
	 * @param change
	 *            the change
	 */
	protected void add(TChange change) {
		EwsUtilities.EwsAssert(change != null, "ChangeList.Add",
				"change is null");
		this.changes.add(change);
	}

	/**
	 * * Gets the number of changes in the collection.
	 * 
	 * @return the count
	 */
	public int getCount() {
		return this.changes.size();
	}

	/**
	 * * Gets an individual change from the change collection.
	 * 
	 * @param index
	 *            the index
	 * @return An single change
	 */
	public TChange getChangeAtIndex(int index) {
		if (index < 0 || index >= this.getCount()) {
			throw new IndexOutOfBoundsException(Strings.IndexIsOutOfRange);
		}
		return this.changes.get(index);
	}

	/**
	 * * Gets the SyncState blob returned by a synchronization operation.
	 * 
	 * @return the sync state
	 */
	public String getSyncState() {
		return this.syncState;
	}

	/**
	 * Sets the sync state.
	 * 
	 * @param syncState
	 *            the new sync state
	 */
	protected void setSyncState(String syncState) {
		this.syncState = syncState;
	}

	/**
	 * * Gets the SyncState blob returned by a synchronization operation.
	 * 
	 * @return the more changes available
	 */
	public boolean getMoreChangesAvailable() {
		return this.moreChangesAvailable;
	}

	/**
	 * Sets the more changes available.
	 * 
	 * @param moreChangesAvailable
	 *            the new more changes available
	 */
	protected void setMoreChangesAvailable(boolean moreChangesAvailable) {
		this.moreChangesAvailable = moreChangesAvailable;
	}

	/**
     * Returns an iterator over a set of elements of type T.
     * 
     * @return an Iterator.
     */
	@Override
	public Iterator iterator() {
		return this.changes.iterator();
	}

}