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


import de.unisiegen.gtitool.core.entities.NonterminalSymbol;
import de.unisiegen.gtitool.core.exceptions.CoreException;
import de.unisiegen.gtitool.core.i18n.Messages;
import de.unisiegen.gtitool.core.parser.style.PrettyString;
import de.unisiegen.gtitool.core.parser.style.PrettyToken;
import de.unisiegen.gtitool.core.parser.style.Style;


/**
 * The {@link NonterminalSymbolIllegalNameException} is used if the
 * {@link NonterminalSymbol} is not correct.
 * 
 * @author Christian Fehler
 * @version $Id: NonterminalSymbolIllegalNameException.java 555 2008-02-12
 *          00:50:47Z fehler $
 */
public final class NonterminalSymbolIllegalNameException extends
    NonterminalSymbolException
{

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


  /**
   * The illegal name of the {@link NonterminalSymbol}.
   */
  private String illegalName;


  /**
   * Allocates a new {@link NonterminalSymbolIllegalNameException}.
   * 
   * @param illegalName The illegal name of the {@link NonterminalSymbol}.
   */
  public NonterminalSymbolIllegalNameException ( String illegalName )
  {
    super ();
    // IllegalName
    if ( illegalName == null )
    {
      throw new NullPointerException ( "illegal name is null" ); //$NON-NLS-1$
    }
    this.illegalName = illegalName;
    // Message and description
    setPrettyMessage ( Messages
        .getPrettyString ( "NonterminalSymbolException.IllegalNameMessage" ) ); //$NON-NLS-1$
    setPrettyDescription ( new PrettyString ( new PrettyToken ( Messages
        .getString (
            "NonterminalSymbolException.IllegalNameDescription", illegalName ), //$NON-NLS-1$
        Style.NONE ) ) );
  }


  /**
   * Returns the illegal name of the {@link NonterminalSymbol}.
   * 
   * @return The illegal name of the {@link NonterminalSymbol}.
   * @see #illegalName
   */
  public final String getIllegalName ()
  {
    return this.illegalName;
  }


  /**
   * {@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 ( "Name:        " ); //$NON-NLS-1$
    result.append ( this.illegalName );
    return result.toString ();
  }
}