Copyright (c) 2000, 2010 IBM Corporation and others.
This program and the accompanying materials
are made available under the terms of the Eclipse Public License 2.0
which accompanies this distribution, and is available at
https://www.eclipse.org/legal/epl-2.0/
SPDX-License-Identifier: EPL-2.0
Contributors:
    IBM Corporation - initial API and implementation
/*******************************************************************************
 * Copyright (c) 2000, 2010 IBM Corporation and others.
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.jdt.internal.corext.refactoring.reorg;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;

import org.eclipse.core.resources.IResource;

import org.eclipse.ltk.core.refactoring.Change;
import org.eclipse.ltk.core.refactoring.ChangeDescriptor;
import org.eclipse.ltk.core.refactoring.RefactoringStatus;
import org.eclipse.ltk.core.refactoring.participants.CheckConditionsContext;
import org.eclipse.ltk.core.refactoring.participants.RefactoringParticipant;
import org.eclipse.ltk.core.refactoring.participants.RefactoringProcessor;
import org.eclipse.ltk.core.refactoring.participants.ReorgExecutionLog;
import org.eclipse.ltk.core.refactoring.participants.SharableParticipants;

import org.eclipse.jdt.core.IJavaElement;
import org.eclipse.jdt.core.JavaModelException;

import org.eclipse.jdt.internal.corext.refactoring.JavaRefactoringArguments;
import org.eclipse.jdt.internal.corext.refactoring.reorg.IReorgDestination;
import org.eclipse.jdt.internal.corext.refactoring.tagging.IQualifiedNameUpdating;
import org.eclipse.jdt.internal.corext.refactoring.tagging.IReferenceUpdating;


public interface IReorgPolicy extends IReorgDestinationValidator {

	
Returns:
the unique id of this policy/**
	 * @return the unique id of this policy
	 */
	public String getPolicyId();

	
Returns:
the source resources to reorg/**
	 * @return the source resources to reorg
	 */
	public IResource[] getResources();

	
Returns:
the source java elements to reorg/**
	 * @return the source java elements to reorg
	 */
	public IJavaElement[] getJavaElements();

	
Throws:
JavaModelException – in unexpected cases
Returns:
true if this policy can handle the source elements/**
	 * @return true if this policy can handle the source elements
	 * @throws JavaModelException in unexpected cases
	 */
	public boolean canEnable() throws JavaModelException;

	
Returns:
the save mode required for this reorg policy
see RefactoringSaveHelper/**
	 * @return the save mode required for this reorg policy
	 *
	 * see RefactoringSaveHelper
	 */
	public int getSaveMode();

	
Can destination be a target for the given source elements?
Params:
destination – the destination to verify
Throws:
JavaModelException – in unexpected cases
Returns:
OK status if valid destination/**
	 * Can destination be a target for the given source elements?
	 *
	 * @param destination the destination to verify
	 * @return OK status if valid destination
	 * @throws JavaModelException in unexpected cases
	 */
	public RefactoringStatus verifyDestination(IReorgDestination destination) throws JavaModelException;

	
Params:
destination – the destination for this reorg/**
	 * @param destination the destination for this reorg
	 */
	public void setDestination(IReorgDestination destination);

	
Returns:
the destination of this reorg or null if not a resource/**
	 * @return the destination of this reorg or null if not a resource
	 */
	public IResource getResourceDestination();

	
Returns:
the destination of this reorg or null if not a java element/**
	 * @return the destination of this reorg or null if not a java element
	 */
	public IJavaElement getJavaElementDestination();

	
Returns:
a descriptor describing a reorg from source to target/**
	 * @return a descriptor describing a reorg from source to target
	 */
	public ChangeDescriptor getDescriptor();


	
Initializes the reorg policy with arguments from a script.
Params:
arguments – 
           the arguments
Returns:
an object describing the status of the initialization. If the
        status has severity FATAL_ERROR, the refactoring
        will not be executed./**
	 * Initializes the reorg policy with arguments from a script.
	 *
	 * @param arguments
	 *            the arguments
	 * @return an object describing the status of the initialization. If the
	 *         status has severity <code>FATAL_ERROR</code>, the refactoring
	 *         will not be executed.
	 */
	public RefactoringStatus initialize(JavaRefactoringArguments arguments);

	public RefactoringStatus checkFinalConditions(IProgressMonitor monitor, CheckConditionsContext context, IReorgQueries queries) throws CoreException;

	public RefactoringParticipant[] loadParticipants(RefactoringStatus status, RefactoringProcessor processor, String[] natures, SharableParticipants shared) throws CoreException;

	public static interface ICopyPolicy extends IReorgPolicy{
		public Change createChange(IProgressMonitor monitor, INewNameQueries queries) throws JavaModelException;
		public ReorgExecutionLog getReorgExecutionLog();
	}

	public static interface IMovePolicy extends IReferenceUpdating, IQualifiedNameUpdating, IReorgPolicy{
		public Change createChange(IProgressMonitor monitor) throws JavaModelException;
		public Change postCreateChange(Change[] participantChanges, IProgressMonitor monitor) throws CoreException;
		public ICreateTargetQuery getCreateTargetQuery(ICreateTargetQueries createQueries);
		public boolean isTextualMove();
		public CreateTargetExecutionLog getCreateTargetExecutionLog();
		public void setDestinationCheck(boolean check);
		public boolean hasAllInputSet();
		
Checks if Java references to the selected element(s) can be updated if moved to
the selected destination. Even if false, participants could still update
non-Java references.
Returns:
true iff Java references to the moved element can be updated
Since:
3.5/**
		 * Checks if <b>Java</b> references to the selected element(s) can be updated if moved to
		 * the selected destination. Even if <code>false</code>, participants could still update
		 * non-Java references.
		 * 
		 * @return <code>true</code> iff <b>Java</b> references to the moved element can be updated
		 * @since 3.5
		 */
		public boolean canUpdateJavaReferences();
		public boolean canUpdateQualifiedNames();
	}
}