com.intellij.openapi.options.SchemesManager Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of core-api Show documentation

A packaging of the IntelliJ Community Edition core-api library. This is release number 1 of trunk branch 142.

The newest version!

/*
 * Copyright 2000-2015 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 com.intellij.util.ThrowableConvertor;
import org.jdom.Element;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

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

public abstract class SchemesManager {
  @NotNull
  public abstract Collection loadSchemes();

  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 getAllSchemes();

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

  public abstract void setCurrentSchemeName(@Nullable String schemeName);

  @Nullable
  public abstract T getCurrentScheme();

  public abstract void removeScheme(@NotNull T scheme);

  @NotNull
  public abstract Collection getAllSchemeNames();

  public abstract File getRootDirectory();

  /**
   * Must be called before {@link #loadSchemes}
   */
  public void loadBundledScheme(@NotNull String resourceName, @NotNull Object requestor, @NotNull ThrowableConvertor convertor) {
  }

  public void setSchemes(@NotNull List schemes) {
    setSchemes(schemes, null);
  }

  public void setSchemes(@NotNull List schemes, @Nullable Condition removeCondition) {
  }

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