ConversionProcessor.java

/*
 * 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 com.intellij.conversion;

/**
 * @author nik
 */
public abstract class ConversionProcessor<Settings> {
  /**
   * @return {@code true} if the settings are in old format and need to be converted
   */
  public abstract boolean isConversionNeeded(Settings settings);

  /**
   * Perform the conversion. Override this method if conversion should be performed before {@link #process} for other converters is invoked
   */
  public void preProcess(Settings settings) throws CannotConvertException {
  }

  /**
   * Perform the conversion
   */
  public abstract void process(Settings settings) throws CannotConvertException ;

  /**
   * Perform the conversion. Override this method if conversion should be performed after {@link #process} for other converters is invoked
   */
  public void postProcess(Settings settings) throws CannotConvertException {
  }
}