/**
 * Copyright (C) 2009 STMicroelectronics
 *
 * This file is part of "Mind Compiler" is free software: you can redistribute 
 * it and/or modify it under the terms of the GNU Lesser General Public License 
 * as published by the Free Software Foundation, either version 3 of the 
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT 
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * Contact: mind@ow2.org
 *
 * Authors: Matthieu Leclercq
 * Contributors: Julien Tous
 */

package org.ow2.mind.compilation;

import static org.objectweb.fractal.adl.error.ErrorTemplateValidator.validErrorTemplate;

import org.objectweb.fractal.adl.error.ErrorTemplate;

/** {@link ErrorTemplate} group for the compiler package. */
public enum CompilerErrors implements ErrorTemplate {

  /** */
  EXECUTION_ERROR(
      0,
      "Unable to execute \"%s\" command. Checks that the command exist and is in the path",
      "command"),

  /** */
  PREPROCESSOR_ERROR(1, "Error while preprocessing the file \"%s\" : \n%s",
      "filename", "ouput"),

  /** */
  COMPILER_ERROR(2, "Error while compiling the file \"%s\" : \n%s", "filename",
      "ouput"),

  /** */
  COMPILER_WARNING(4, "Warnings while compiling the file \"%s\" : \n%s",
      "filename", "ouput"),

  /** */
  LINKER_ERROR(3, "Error while linking the file \"%s\" : \n%s", "filename",
      "ouput"),

  /** */
  LINKER_WARNING(5, "Warning while linking the file \"%s\" : \n%s", "filename",
      "ouput"),

  /** */
  ASSEMBLER_ERROR(6, "Error while assembling the file \"%s\" : \n%s",
      "filename", "ouput"),

  /** */
  ASSEMBLER_WARNING(7, "Warning while assembling the file \"%s\" : \n%s",
      "filename", "ouput");

  /** The groupId of ErrorTemplates defined in this enumeration. */
  public static final String GROUP_ID = "CPI";

  private int                id;
  private String             format;

  private CompilerErrors(final int id, final String format,
      final Object... args) {
    this.id = id;
    this.format = format;

    assert validErrorTemplate(this, args);
  }

  public int getErrorId() {
    return id;
  }

  public String getGroupId() {
    return GROUP_ID;
  }

  public String getFormatedMessage(final Object... args) {
    return String.format(format, args);
  }

  public String getFormat() {
    return format;
  }
}