plugins/org.eclipse.jst.j2ee/common/org/eclipse/jst/j2ee/model/IModelProvider.java

/*******************************************************************************
 * Copyright (c) 2005, 2007 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
 *******************************************************************************/
package org.eclipse.jst.j2ee.model;

import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Path;

/**
 * Simple J2EE model registration interface that serves to unify the various model access api's
 *
 */
public interface IModelProvider {
	
	// Flag used to save in memory model when no file exists.
	final static IPath FORCESAVE = new Path("FORCE"); //$NON-NLS-1$

	/**
	 * This returns the designated "default" model for the given context
	 * @return Object
	 */
	Object getModelObject();
	/**
	 * This returns the model specifically for a given path within the model context, path can also be used
	 * to designate the source of the model (xml, java annotations, etc..)
	 * @param modelPath
	 * @return Object
	 */
	Object getModelObject(IPath modelPath);
	/**
	 * The modify method should be used during a write operation on the model.  
	 * The model will be properly accessed, saved and released
	 * Note:  All implementors need to ensure all model access using this instance within the runnable block
     *        Use a cached/consistent view of the model that is being modified
     *  This method does not support nested writable views, and should return a RuntimeException if this is detected
	 * @param runnable {@link Runnable} - User specified code that alters the model. 
	 * @param modelPath {@link IPath} - Optional path to specify which model instance will be modified
	 */
	void modify(Runnable runnable, IPath modelPath);
	
	/**
	 * Validate edit for resource state 
	 *
	 * @param modelPath - Path of resource verifying, or null if default resource.
	 * @param context - The context object to help display dialogs etc, or null, then IWorkspace.VALIDATE_PROMPT will be used
	 * @return IStatus
	 */
	IStatus validateEdit(IPath modelPath, Object context);

	/**
	 * Add a listener to listen for model changes.
	 * @param listener 
	 */
	void addListener(IModelProviderListener listener);

	/**
	 * Remove a listener from the list of model change listeners
	 * @param listener
	 */
	void removeListener(IModelProviderListener listener);
}