com.mgz.afp.base.StructuredFieldErrornouslyBuilt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of alpheusafpparser Show documentation

Alpheus AFP Parser is a library and parser for the IBM Advanced Function Presentation (AFP) document/print stream format. Alpheus covers all AFP specifications: MO:DCA, BCOCA, CMOCA, FOCA, GOCA, IOCA, and PTOCA. It is a complete implementation. Every Structured Field, Repeating Group, and Triplet is fully implemented as Java class. Alpheus AFP Parser was written from scratch and has no external dependencies. Copyright 2015,2016 Rudolf Fiala Alpheus AFP Parser is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

The newest version!

/*
Copyright 2015 Rudolf Fiala

This file is part of Alpheus AFP Parser.

Alpheus AFP Parser is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

Alpheus AFP Parser 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 General Public License for more details.

You should have received a copy of the GNU General Public License
along with Alpheus AFP Parser.  If not, see 
*/
package com.mgz.afp.base;

import com.mgz.afp.exceptions.AFPParserException;
import com.mgz.afp.parser.AFPParser;
import com.mgz.afp.parser.AFPParserConfiguration;


/**
 * If an exception happens the parser builds a structured field of type {@link
 * StructuredFieldErrornouslyBuilt}.
 
 Note that {@link AFPParserConfiguration#setEscalateParsingErrors(boolean)}
 * has to be set to true for this behavior. Otherwise the parser escalates the occurring {@link
 * AFPParserException} to {@link AFPParser#error(AFPParserException)}.
 
 Note that the {@link
 * StructuredFieldErrornouslyBuilt#getData()} returns the gross payload, this is the SF's data,
 * including padding data. The {@link StructuredFieldErrornouslyBuilt#getPadding()} returns
 * null.

 */
public class StructuredFieldErrornouslyBuilt extends StructuredFieldBaseData {
  Throwable causingException;

  /**
   * Returns the exception that happened when the parser tried to build this {@link
   * StructuredFieldErrornouslyBuilt}
   */
  public Throwable getCausingException() {
    return causingException;
  }

  public void setCausingException(Throwable causingException) {
    this.causingException = causingException;
  }
}