/**
 * <copyright> Copyright 2006 by Know-Center, Graz, Austria </copyright>
 * PDF-AS has been contracted by the E-Government Innovation Center EGIZ, a
 * joint initiative of the Federal Chancellery Austria and Graz University of
 * Technology.
 *
 * Licensed under the EUPL, Version 1.1 or - as soon they will be approved by
 * the European Commission - subsequent versions of the EUPL (the "Licence");
 * You may not use this work except in compliance with the Licence.
 * You may obtain a copy of the Licence at:
 * http://www.osor.eu/eupl/
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the Licence is distributed on an "AS IS" basis,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the Licence for the specific language governing permissions and
 * limitations under the Licence.
 *
 * This product combines work with different licenses. See the "NOTICE" text
 * file for details on the various modules and licenses.
 * The "NOTICE" text file is part of the distribution. Any derivative works
 * that you distribute must include a readable copy of the "NOTICE" text file.
 */
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;
  }
}