Package com.inet.pdfc.generator.message

Class InfoData

java.lang.Object
com.inet.pdfc.generator.message.InfoData
All Implemented Interfaces:
Chunk, Serializable
@JsonData public class InfoData extends Object implements Chunk
information about a specific page comparison
See Also:

  • Constructor Details

    • InfoData

      public InfoData(PdfSource f1, PdfSource f2, int firstTotalPages, int secondTotalPages, IProfile comparisonConfig)
      default constructor with necessary dependencies
      Parameters:
      f1 - file of the first PDF being compared
      f2 - file of the second PDF being compared
      firstTotalPages - total number of pages in the first PDF, use -1 for uninitialized
      secondTotalPages - total number of pages in the second PDF, use -1 for uninitialized
      comparisonConfig - the configuration used to create the current results, if null a DefaultProfile will be used furthermore used as a hint for the garbage collector.
      Since:
      4.0

    • InfoData

      public InfoData(PdfSource f1, PdfSource f2, IProfile comparisonConfig)
      creates the instance for not yet parsed files. In that case the page count is undefined and will be set to -1
      Parameters:
      f1 - file of the first PDF being compared
      f2 - file of the second PDF being compared
      comparisonConfig - the configuration used to create the current results, if null a DefaultProfile will be used
      Since:
      4.0

  • Method Details

    • getSecondFile

      public PdfSource getSecondFile()
      returns the file of the first PDF being compared
      Returns:
      the file of the first PDF being compared, can be null if a file is missing in batch mode!
      Since:
      4.0

    • getFirstFile

      public PdfSource getFirstFile()
      returns the file of the secondPDF being compared
      Returns:
      the file of the second PDF being compared, can be null if a file is missing in batch mode!
      Since:
      4.0

    • getFirstTotalPageNumber

      @Deprecated public int getFirstTotalPageNumber()
      Deprecated.
      As of i-net PDFC 5.0 please migrate to getFirstPageCount()
      returns the total number of pages in the first PDF
      Returns:
      the total number of pages in the first PDF, -1 if uninitialized
      Since:
      4.0

    • getFirstPageCount

      public int getFirstPageCount()
      returns the total number of pages in the first PDF
      Returns:
      the total number of pages in the first PDF, -1 if uninitialized
      Since:
      5.0

    • getSecondTotalPageNumber

      @Deprecated public int getSecondTotalPageNumber()
      Deprecated.
      As of i-net PDFC 5.0 please migrate to getFirstPageCount()
      returns the total number of pages in the second PDF
      Returns:
      the total number of pages in the secondPDF, -1 if uninitialized
      Since:
      4.0

    • getSecondPageCount

      public int getSecondPageCount()
      returns the total number of pages in the second PDF
      Returns:
      the total number of pages in the secondPDF, -1 if uninitialized
      Since:
      5.0

    • getProfile

      public IProfile getProfile()
      Returns the profile which was used for this comparison run. The returned instance is a copy of the profile used by the comparer.
      Returns:
      the compare profile, never null
      Since:
      4.0

    • getType

      public Chunk.ChunkType getType()
      Returns the type of this chunk
      Specified by:
      getType in interface Chunk
      Returns:
      the type of this chunk