/*
 * 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 consulo.versionControlSystem.checkout;

import consulo.annotation.component.ComponentScope;
import consulo.annotation.component.ExtensionAPI;
import consulo.component.extension.ExtensionPointName;
import consulo.project.Project;
import consulo.ui.ex.util.TextWithMnemonic;
import consulo.versionControlSystem.VcsKey;
import org.jetbrains.annotations.NonNls;

import jakarta.annotation.Nonnull;
import jakarta.annotation.Nullable;
import java.io.File;
import java.util.Comparator;

/**
 * Implement this interface and register it as extension to checkoutProvider extension point in order to provide checkout
 */
@ExtensionAPI(ComponentScope.APPLICATION)
public interface CheckoutProvider {
  ExtensionPointName<CheckoutProvider> EXTENSION_POINT_NAME = ExtensionPointName.create(CheckoutProvider.class);

  void doCheckout(@Nonnull final Project project, @Nullable Listener listener);

  @NonNls
  String getVcsName();

  interface Listener {
    void directoryCheckedOut(File directory, VcsKey vcs);

    void checkoutCompleted();
  }

  class CheckoutProviderComparator implements Comparator<CheckoutProvider> {
    @Override
    public int compare(final CheckoutProvider o1, final CheckoutProvider o2) {
      return TextWithMnemonic.parse(o1.getVcsName()).getText().compareTo(TextWithMnemonic.parse(o2.getVcsName()).getText());
    }
  }
}
