/**
 * Copyright (C) 2009 STMicroelectronics
 * Copyright (C) 2013 Schneider-Electric
 *
 * 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: Stephane Seyvoz
 */

package org.ow2.mind.preproc;

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

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

/**
 * {@link ErrorTemplate} for MIND pre-processor.
 */
public enum MPPErrors implements ErrorTemplate {

  /** */
  INPUT_FILE_NOT_FOUND(0, "Can't open input file %s", "<input file>"),

  /** */
  PARSE_ERROR(1, "Parse error : %s", "<parse error>"),

  /** */
  UNKNOWN_INTERFACE(2, "Unknown interface \"%s\".", "<itfName>"),

  /** */
  UNKNOWN_METHOD(3, "In interface \"%s\" unkown method \"%s\".", "<itfName>",
      "<methName>"),

  /** */
  INVALID_CLIENT_INTERFACE(
      4,
      "Interface \"%s\" is a client interface, method \"%s\" cannot be defined here.",
      "<itf name>", "<meth name>"),

  /** */
  UNKNOWN_ATTRIBUTE(5, "Unknown attribute \"%s\".", "<attName>"),

  /** */
  INVALID_INDEX(6, "In interface \"%s\" invalid index \"%s\".", "<itfName>",
      "<index>"),

  /** */
  INVALID_INTERFACE_MISSING_INDEX(
      7,
      "Interface \"%s\" is a collection interface, an index must be specified.",
      "<itf name>"),

  /** */
  INVALID_INTERFACE_NOT_A_COLLECTION(
      8,
      "Interface \"%s\" is not a collection interface, an index cannot be specified here.",
      "<itf name>"),

  /** */
  MISSING_PRIVATE_DECLARATION(9,
      "Missing declaration of PRIVATE structure in \"%s\".", "<data file name>"),

  /** */
  UNKNOWN_DATAFIELD(10, "Invalid PRIVATE access, no such field \"%s\".",
      "<fieldName>"),

  /** */
  MISSING_METHOD_DECLARATION(11,
      "In definition %s: METH(%s, %s) method(s) haven't been implemented !",
      "<defName>", "<itfName>", "<methName>"),

  /** */
  MISSING_COLL_METHOD_DECLARATION(
      12,
      "In definition %s: METH(%s[%s], %s) method(s) haven't been implemented !",
      "<defName>", "<itfName>", "<idxStr>", "<methName>"), ;

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

  private int                id;
  private String             format;

  private MPPErrors(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;
  }

}