bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/internal/decorators/DecorationReference.java

/*******************************************************************************
 * Copyright (c) 2000, 2003 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials 
 * are made available under the terms of the Common Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/cpl-v10.html
 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.ui.internal.decorators;

import org.eclipse.ui.internal.misc.Assert;



/**
 * A DecorationReference is a class that holds onto the starting
 * text and image of a decoration.
 */
class DecorationReference {

	Object element;
	Object adaptedElement;
	boolean forceUpdate = false;

	DecorationReference(Object object) {
		Assert.isNotNull(object);
		element = object;
	}

	DecorationReference(Object object, Object adaptedObject) {
		this(object);
		this.adaptedElement = adaptedObject;
	}

	/**
	 * Returns the adaptedElement.
	 * @return Object
	 */
	public Object getAdaptedElement() {
		return adaptedElement;
	}

	/**
	 * Returns the element.
	 * @return Object
	 */
	public Object getElement() {
		return element;
	}

	/**
	 * Return true if an update should occur whether or 
	 * not there is a result.
	 * @return boolean
	 */
	public boolean shouldForceUpdate() {
		return forceUpdate;
	}

	/**
	 * Sets the forceUpdate flag. If true an update 
	 * occurs whether or not a decoration has resulted.
	 * @param forceUpdate The forceUpdate to set
	 */
	public void setForceUpdate(boolean forceUpdate) {
		this.forceUpdate = forceUpdate;
	}

}