com.intellij.openapi.options.SchemeProcessor 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-2014 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.InvalidDataException;
import com.intellij.openapi.util.WriteExternalException;
import org.jdom.Document;
import org.jdom.JDOMException;
import org.jdom.Parent;
import org.jetbrains.annotations.NotNull;

import java.io.IOException;

/**
 * Please extend {@link BaseSchemeProcessor} to avoid compatibility issues
 */
public interface SchemeProcessor {
  @Deprecated
  T readScheme(@NotNull Document schemeContent) throws InvalidDataException, IOException, JDOMException;

  Parent writeScheme(@NotNull T scheme) throws WriteExternalException;

  @Deprecated
  /**
   * @deprecated Implement {@link BaseSchemeProcessor#getState(ExternalizableScheme)}
   */
  boolean shouldBeSaved(@NotNull T scheme);

  void initScheme(@NotNull T scheme);

  void onSchemeAdded(@NotNull T scheme);

  void onSchemeDeleted(@NotNull T scheme);

  void onCurrentSchemeChanged(final Scheme oldCurrentScheme);
}