java/compiler/impl/src/com/intellij/openapi/compiler/generic/GenericCompiler.java

/*
 * Copyright 2000-2010 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.compiler.generic;

import com.intellij.openapi.compiler.CompileContext;
import com.intellij.openapi.compiler.CompileScope;
import com.intellij.openapi.compiler.Compiler;
import com.intellij.util.io.DataExternalizer;
import com.intellij.util.io.EnumeratorStringDescriptor;
import com.intellij.util.io.KeyDescriptor;
import org.jetbrains.annotations.NotNull;

/**
 * @author nik
 *
 * @deprecated this interface is part of the obsolete build system which runs as part of the IDE process. Since IDEA 12 plugins need to
 * integrate into 'external build system' instead (http://confluence.jetbrains.com/display/IDEADEV/External+Builder+API+and+Plugins).
 * Since IDEA 13 users cannot switch to the old build system via UI and it will be completely removed in IDEA 14.
 */
public abstract class GenericCompiler<Key, SourceState, OutputState> implements Compiler {
  protected static final KeyDescriptor<String> STRING_KEY_DESCRIPTOR = new EnumeratorStringDescriptor();
  private final String myId;
  private final int myVersion;
  private final CompileOrderPlace myOrderPlace;

  protected GenericCompiler(@NotNull String id, int version, @NotNull CompileOrderPlace orderPlace) {
    myId = id;
    myVersion = version;
    myOrderPlace = orderPlace;
  }

  @NotNull
  public abstract KeyDescriptor<Key> getItemKeyDescriptor();
  @NotNull
  public abstract DataExternalizer<SourceState> getSourceStateExternalizer();
  @NotNull
  public abstract DataExternalizer<OutputState> getOutputStateExternalizer();

  @NotNull
  public abstract GenericCompilerInstance<?, ? extends CompileItem<Key, SourceState, OutputState>, Key, SourceState, OutputState> createInstance(@NotNull CompileContext context);

  public final String getId() {
    return myId;
  }

  public final int getVersion() {
    return myVersion;
  }

  @Override
  public boolean validateConfiguration(CompileScope scope) {
    return true;
  }

  public CompileOrderPlace getOrderPlace() {
    return myOrderPlace;
  }

  public enum CompileOrderPlace {
    CLASS_INSTRUMENTING, CLASS_POST_PROCESSING, PACKAGING, VALIDATING
  }

}