/*
 * Copyright 2000-2012 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.content.library.ui;

import consulo.application.progress.ProgressIndicator;
import consulo.content.library.LibraryRootType;
import consulo.virtualFileSystem.VirtualFile;

import jakarta.annotation.Nonnull;
import jakarta.annotation.Nullable;
import java.util.Collection;
import java.util.List;

/**
 * @author nik
 */
public abstract class LibraryRootsDetector {
  @Nonnull
  public static LibraryRootsDetector of(List<? extends RootDetector> detectors) {
    return new LibraryRootsDetectorImpl(detectors);
  }

  /**
   * Find suitable roots in {@code rootCandidate} or its descendants.
   *
   * @param rootCandidate     file selected in the file chooser by user
   * @param progressIndicator can be used to show information about the progress and to abort searching if process is cancelled
   * @return suitable roots
   */
  public abstract Collection<DetectedLibraryRoot> detectRoots(@Nonnull VirtualFile rootCandidate, @Nonnull ProgressIndicator progressIndicator);

  /**
   * @return presentable name for the root type or {@code null} if the root type isn't supported by this detector
   */
  @Nullable
  public abstract String getRootTypeName(@Nonnull LibraryRootType rootType);
}
