/**
 * 
 */
package at.gv.egiz.pdfas.exceptions.pdf;

import at.gv.egiz.pdfas.exceptions.ErrorCode;
import at.knowcenter.wag.egov.egiz.exceptions.PDFDocumentException;

/**
 * Exception thrown when a caption ("label") is not found in the content stream
 * when determining the placeholders.
 * 
 * <p>
 * This usually happens when the space for a caption is too small. Then the
 * caption is wrapped into two lines and usually the separating whitespace is
 * lost thus the BinarySignature is unable to find the caption String.
 * </p>
 * 
 * @author wprinz
 */
public class CaptionNotFoundException extends PDFDocumentException
{

  /**
   * SVUID.
   */
  private static final long serialVersionUID = -8959043531007857665L;

  /**
   * The problematic caption.
   */
  protected String caption = null;

  /**
   * Constructor.
   * 
   * @param caption
   *          The problematic caption.
   */
  public CaptionNotFoundException(String caption)
  {
    super(ErrorCode.CAPTION_NOT_FOUND_EXCEPTION, "Caption not found in content stream. caption = " + caption);
    this.caption = caption;
  }

  /**
   * Returns the problematic caption.
   * 
   * @return Returns the problematic caption.
   */
  public String getCaption()
  {
    return this.caption;
  }
}