IDefinitionContext.java

/******************************************************************************* 
 * Copyright (c) 2015 Red Hat, Inc. 
 * Distributed under license by Red Hat, Inc. All rights reserved. 
 * This program is 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: 
 * Red Hat, Inc. - initial API and implementation 
 ******************************************************************************/ 
package org.jboss.tools.batch.core;

import java.util.List;

import org.eclipse.core.runtime.IPath;
import org.jboss.tools.batch.internal.core.impl.definition.TypeDefinition;

/**
 * 
 * @author Viacheslav Kabanovich
 *
 */
public interface IDefinitionContext {

	/**
	 * Returns existing working copy of original context, or this object if it is a working copy.
	 * 
	 * @return
	 */
	public IDefinitionContext getWorkingCopy();

	/**
	 * Creates copy of this object and makes it the working copy bounded to this object.
	 * 
	 * @param forFullBuild
	 */
	public void newWorkingCopy(boolean forFullBuild);

	/**
	 * Submits loaded definitions to original context.
	 */
	public void applyWorkingCopy();

	/**
	 * Removes all definitions.
	 */
	public void clean();

	/**
	 * Removes difinitions loaded from path.
	 * 
	 * @param path
	 */
	public void clean(IPath path);

	/**
	 * Removes definitions loaded from type
	 * 
	 * @param typeName
	 */
	public void clean(String typeName);

	/**
	 * Returns list of TypeDefinition defined and stored inside this context.
	 * 
	 * @return list of TypeDefinition defined and stored inside this context
	 */
	public List<TypeDefinition> getTypeDefinitions();

}