/*
 * Copyright 2000-2009 JetBrains s.r.o.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.intellij.refactoring.move.moveClassesOrPackages;

import com.intellij.openapi.extensions.ExtensionPointName;
import com.intellij.psi.PsiClass;
import com.intellij.psi.PsiDirectory;
import com.intellij.usageView.UsageInfo;
import com.intellij.util.IncorrectOperationException;
import org.jetbrains.annotations.Contract;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import java.util.Collection;

/**
 * Defines a handler for moving a class to a different package/class/etc.
 * In addition to moving a class the handler can also register handlers that are executed before moving and after moving the class.
 *
 * @author Maxim.Medvedev
 * @see MoveClassesOrPackagesProcessor
 */
public interface MoveClassHandler {
  ExtensionPointName<MoveClassHandler> EP_NAME = new ExtensionPointName<>("com.intellij.refactoring.moveClassHandler");

  void prepareMove(@NotNull PsiClass aClass);

  void finishMoveClass(@NotNull PsiClass aClass);

  /**
   * @return null if it cannot move aClass
   */
  @Nullable
  PsiClass doMoveClass(@NotNull PsiClass aClass, @NotNull PsiDirectory moveDestination) throws IncorrectOperationException;

  /**
   * Returns the fully qualified name of the passed class that is the handler can deduce
   * @param clazz an instance of {@link PsiClass} to get the name for
   * @return null, if this instance of FileNameForPsiProvider cannot provide name for clazz
   */
  @Contract(pure = true)
  String getName(@NotNull PsiClass clazz);

  void preprocessUsages(@NotNull Collection<UsageInfo> results);
}
