/*******************************************************************************
 * Copyright (c) 2009 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *     Zend Technologies
 *******************************************************************************/
package org2.eclipse.php.internal.core.preferences;

import java.util.EventObject;

import org.eclipse.core.resources.IProject;

import com.aptana.editor.php.core.preferences.TaskTag;

/**
 * A TaskTagsEvent event gets delivered whenever a changes is made to the task
 * tags list of the workspace or the project.
 * <P>
 * The event source is always the TaskTagsProvider reference.
 * 
 * @author shalom
 */
public class TaskTagsEvent extends EventObject {

	private static final long serialVersionUID = 7470422791883879563L;
	private TaskTag[] tags;
	private IProject project;
	private boolean isCaseSensitive;

	/**
	 * Constructs a new TaskTagsEvent.
	 * 
	 * @param provider
	 *            The source of the event (always a TaskTagsProvider)
	 * @param project
	 *            The project that is effected by the task tags change (null
	 *            indicates that the change is in the workspace settings)
	 * @param tags
	 *            The updated task tags.
	 * @param isCaseSensitive
	 *            Indicate that the tags should be compiled as case-sensitive.
	 */
	public TaskTagsEvent(TaskTagsProvider provider, IProject project,
			TaskTag[] tags, boolean isCaseSensitive) {
		super(provider);
		this.project = project;
		this.tags = tags;
		this.isCaseSensitive = isCaseSensitive;
	}

	/**
	 * Returns the IProject that was effected by the task tags change. The
	 * method will return null to indicate that the change was made in the
	 * workspace settings.
	 * 
	 * @return The effected IProject, or null if the effect is on the workspace.
	 */
	public IProject getProject() {
		return project;
	}

	/**
	 * Returns the updated task tags.
	 * 
	 * @return
	 */
	public TaskTag[] getTaskTags() {
		return tags;
	}

	/**
	 * Returns true if the task tags are case sensitive.
	 * 
	 * @return The case sensitivity state of the task tags for the defined
	 *         IProject or workspace.
	 */
	public boolean isCaseSensitive() {
		return isCaseSensitive;
	}

	public String toString() {
		StringBuffer buffer = new StringBuffer();
		buffer.append("[TaskTagsEvent: project = ");//$NON-NLS-1$
		buffer.append(getProject());
		buffer.append(", TaskTags = {");//$NON-NLS-1$
		if (tags == null) {
			buffer.append("null}");//$NON-NLS-1$
		} else {
			for (int i = 0; i < tags.length; i++) {
				buffer.append(tags[i]);
				if (i + 1 < tags.length) {
					buffer.append(", ");//$NON-NLS-1$
				}
			}
			buffer.append('}');
		}
		buffer.append(", Case-Sensitive = ");//$NON-NLS-1$
		buffer.append(isCaseSensitive());
		buffer.append(']');
		return buffer.toString();
	}
}