package de.unisiegen.gtitool.core.exceptions.grammar;


import java.util.ArrayList;

import de.unisiegen.gtitool.core.entities.Production;
import de.unisiegen.gtitool.core.entities.ProductionWordMember;
import de.unisiegen.gtitool.core.entities.Symbol;
import de.unisiegen.gtitool.core.exceptions.CoreException;
import de.unisiegen.gtitool.core.exceptions.ProductionWordMembersInvolvedException;
import de.unisiegen.gtitool.core.i18n.Messages;


/**
 * The {@link GrammarRegularGrammarException} is used, if the grammar is not
 * regular.
 * 
 * @author Benjamin Mies
 * @version $Id: GrammarRegularGrammarException.java 1372 2008-10-30 08:36:20Z
 *          fehler $
 */
public final class GrammarRegularGrammarException extends GrammarException
    implements ProductionWordMembersInvolvedException
{

  /**
   * The serial version uid.
   */
  private static final long serialVersionUID = -1567778166577632469L;


  /**
   * List of involved productions.
   */
  private Production production;


  /**
   * The involved {@link Symbol}s.
   */
  private ArrayList < ProductionWordMember > symbols;


  /**
   * Allocates a new {@link GrammarRegularGrammarException}.
   * 
   * @param production The {@link Production}.
   * @param symbols The involved {@link Symbol}s.
   */
  public GrammarRegularGrammarException ( Production production,
      ArrayList < ProductionWordMember > symbols )
  {
    super ();

    // production
    if ( production == null )
    {
      throw new NullPointerException ( "production is null" ); //$NON-NLS-1$
    }
    this.production = production;

    // symbols
    if ( symbols == null )
    {
      throw new NullPointerException ( "symbols is null" ); //$NON-NLS-1$
    }
    this.symbols = symbols;

    // message
    setPrettyMessage ( Messages
        .getPrettyString ( "GrammarRegularGrammarException.Message" ) ); //$NON-NLS-1$

    // description
    setPrettyDescription ( Messages.getPrettyString (
        "GrammarRegularGrammarException.Description", //$NON-NLS-1$
        this.production.toPrettyString () ) );
  }


  /**
   * {@inheritDoc}
   * 
   * @see ProductionWordMembersInvolvedException#getProductionWordMember()
   */
  public ArrayList < ProductionWordMember > getProductionWordMember ()
  {
    return this.symbols;
  }


  /**
   * {@inheritDoc}
   * 
   * @see CoreException#getType()
   */
  @Override
  public final ErrorType getType ()
  {
    return ErrorType.ERROR;
  }


  /**
   * {@inheritDoc}
   * 
   * @see Throwable#toString()
   */
  @Override
  public final String toString ()
  {
    String lineBreak = System.getProperty ( "line.separator" ); //$NON-NLS-1$
    StringBuilder result = new StringBuilder ( super.toString () );
    result.append ( lineBreak );
    result.append ( "Production: " ); //$NON-NLS-1$
    result.append ( this.production.toString () );
    return result.toString ();
  }
}