SchemeManager.java

/*
 * Copyright 2000-2017 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.openapi.options;

import com.intellij.openapi.util.Condition;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import java.io.File;
import java.util.Collection;
import java.util.List;

@SuppressWarnings("UnusedParameters")
public abstract class SchemeManager<T extends Scheme> {
  public final static String EDITABLE_COPY_PREFIX = "_@user_";

  @NotNull
  public abstract Collection<T> loadSchemes();

  public void reload() {
  }

  public abstract void addNewScheme(@NotNull T scheme, boolean replaceExisting);

  public void addScheme(@NotNull T scheme) {
    addNewScheme(scheme, true);
  }

  /**
   * Consider to use {@link #setSchemes}
   */
  public abstract void clearAllSchemes();

  @NotNull
  public abstract List<T> getAllSchemes();

  public boolean isEmpty() {
    return getAllSchemes().isEmpty();
  }

  @Nullable
  public abstract T findSchemeByName(@NotNull String schemeName);

  /**
   * If schemes are lazy loaded, you can use this method to postpone scheme selection (scheme will be found by name on first use)
   */
  public final void setCurrentSchemeName(@Nullable String schemeName) {
    setCurrentSchemeName(schemeName, true);
  }

  public abstract void setCurrentSchemeName(@Nullable String schemeName, boolean notify);

  public final void setCurrent(@Nullable T scheme) {
    setCurrent(scheme, true);
  }

  public void setCurrent(@Nullable T scheme, boolean notify) {
    setCurrentSchemeName(scheme == null ? null : scheme.getName());
  }

  @Nullable
  public abstract T getCurrentScheme();

  @Nullable
  public String getCurrentSchemeName() {
    T scheme = getCurrentScheme();
    return scheme == null ? null : scheme.getName();
  }

  public abstract boolean removeScheme(@NotNull T scheme);

  @Nullable
  public T removeScheme(@NotNull String name) {
    T scheme = findSchemeByName(name);
    if (scheme != null) {
      removeScheme(scheme);
      return scheme;
    }
    return null;
  }

  @NotNull
  public abstract Collection<String> getAllSchemeNames();

  public abstract File getRootDirectory();

  /**
   * Must be called before {@link #loadSchemes}.
   *
   * Scheme manager processor must be LazySchemeProcessor
   */
  public void loadBundledScheme(@NotNull String resourceName, @NotNull Object requestor) {
  }

  public final void setSchemes(@NotNull List<T> newSchemes) {
    setSchemes(newSchemes, null, null);
  }

  public final void setSchemes(@NotNull List<T> newSchemes, @Nullable T newCurrentScheme) {
    setSchemes(newSchemes, newCurrentScheme, null);
  }

  public void setSchemes(@NotNull List<T> newSchemes, @Nullable T newCurrentScheme, @Nullable Condition<T> removeCondition) {
  }

  /**
   * Bundled / read-only (or overriding) scheme cannot be renamed or deleted.
   */
  public boolean isMetadataEditable(@NotNull T scheme) {
    return true;
  }

  public static String getDisplayName(@NotNull Scheme scheme) {
    String schemeName = scheme.getName();
    return
      schemeName.startsWith(EDITABLE_COPY_PREFIX) ?
      schemeName.substring(EDITABLE_COPY_PREFIX.length()) :
      schemeName;
  }

  public void save(@NotNull List<Throwable> errors) {
  }
}