concatenatePdf

Code

IPdfResult PdfUtils.concatenatePdf(String newPdfFileName, String... addPdfFileNames)

Beschreibung

Generierung einer neuen PDF-Datei durch Konkatenation von mehreren PDF-Dateien.

Parameter

• newPdfFileName
  Name der zu generierenden PDF-Datei (mit vollständiger Pfadangabe).
• addPdfFileNames
  Eine oder mehrere PDF-Dateien (mit vollständiger Pfadangabe), die zu einer PDF-Datei zusammengefügt werden sollen.
  Die Reihenfolge der PDF-Dateien findet sich in dem generierten PDF-Dokument wieder.
  Die PDF-Dateien können wie folgt übergeben werden: String[], List<String> oder als einzelne Argumente vom Typ String.
  
  

Rückgabe

Ergebnis der PDF Konkatenation
Folgende Methoden stehen in dem Rückgabeobjekt IPdfResult zur Verfügung:

• String getFileName()
  Name der generierten PDF-Datei (mit vollständiger Pfadangabe). Der übergebene Dateiname (newPdfFileName) wird auf Gültigkeit geprüft und falls notwendig korrigiert. Ungültige Zeichen werden durch das Zeichen _ ersetzt und die Dateiendung pdf wird sofern notwendig angehängt. 

• boolean isSuccessful()
  War die PDF Konkatenation erfolgreich?

• String getErrorCode()
  Liefert den Fehlercode, falls die PDF Konkatenation nicht erfolgreich war. Mit Hilfe der Fehlercodes können individuelle Ausgaben im Skripting hinterlegt werden.
  Folgende Fehlercodes stehen als Konstanten in der Klasse PdfConstants zur Verfügung

  • PdfConstants.PDF_ERRORCODE_NOTSUPPORTED_FILETYPE
    Dieser Dateityp wird bei der PDF Konkatenation nicht unterstützt.

  • PdfConstants.PDF_ERRORCODE_FILENOTFOUND
    Eine der übergebenen Pdf-Dateien ist nicht vorhanden.

  • PdfConstants.PDF_ERRORCODE_NOTSUPPORTED_PDFFORMAT
    Das PDF Format einer übergebenen Datei wird nicht unterstützt.

  • PdfConstants.PDF_ERRORCODE_GENERAL
    Ein allgemeiner Fehler ist bei der PDF Konkatenation aufgetreten.
    
    

Beispiele

String fileName1 = "C:/source/Quote.pdf";
String fileName2 = "C:/source/Flyer1.pdf";
String fileName3 = "C:/source/Flyer2.pdf";
String[] pdfFiles = new String[3];
pdfFiles[0] = fileName1;
pdfFiles[1] = fileName2;
pdfFiles[2] = fileName3;
IPdfResult result = PdfUtils.concatenatePdf("C:/target/myNewPdfFile.pdf", pdfFiles);


// Alternate variant for use of method with same result
// IPdfResult result = PdfUtils.concatenatePdf("C:/target/myNewPdfFile.pdf", fileName1, fileName2, fileName3);


if (!result.isSuccessful())
{
	if (ScriptUtils.equal(PdfConstants.PDF_ERRORCODE_NOTSUPPORTED_FILETYPE, result.getErrorCode()))
	{
		...Error handling...
	}
}
else
{
	...do something with result.getFileName()
}