You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pdfbox.apache.org by ms...@apache.org on 2020/12/29 13:36:13 UTC
svn commit: r1884908 - in
/pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools:
DecompressObjectstreams.java Decrypt.java Encrypt.java ExportFDF.java
ExportXFDF.java ExtractImages.java ExtractText.java ImageToPDF.java
Author: msahyoun
Date: Tue Dec 29 13:36:13 2020
New Revision: 1884908
URL: http://svn.apache.org/viewvc?rev=1884908&view=rev
Log:
PDFBOX-2602: use options instead or parameters as suggested by clig.dev
Modified:
pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/DecompressObjectstreams.java
pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/Decrypt.java
pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/Encrypt.java
pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ExportFDF.java
pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ExportXFDF.java
pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ExtractImages.java
pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ExtractText.java
pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ImageToPDF.java
Modified: pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/DecompressObjectstreams.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/DecompressObjectstreams.java?rev=1884908&r1=1884907&r2=1884908&view=diff
==============================================================================
--- pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/DecompressObjectstreams.java (original)
+++ pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/DecompressObjectstreams.java Tue Dec 29 13:36:13 2020
@@ -27,7 +27,6 @@ import org.apache.pdfbox.pdmodel.PDDocum
import picocli.CommandLine;
import picocli.CommandLine.Command;
import picocli.CommandLine.Option;
-import picocli.CommandLine.Parameters;
/**
* This program will just save the loaded pdf without any changes. As PDFBox doesn't support writing compressed object
@@ -47,11 +46,10 @@ public final class DecompressObjectstrea
@Option(names = {"-h", "--help"}, usageHelp = true, description = "display this help message")
boolean usageHelpRequested;
- @Parameters(paramLabel = "inputfile", index = "0", description = "the PDF file to decompress.")
+ @Option(names = {"-i", "--input"}, description = "the PDF file to decompress", required = true)
private File infile;
- @Parameters(paramLabel = "outputfile", index = "1", arity = "0..1", description = "the decompressed PDF file. " +
- "If omitted the original file is overwritten.")
+ @Option(names = {"-o", "--output"}, description = "the decompressed PDF file. If omitted the original file is overwritten.")
private File outfile;
/**
Modified: pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/Decrypt.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/Decrypt.java?rev=1884908&r1=1884907&r2=1884908&view=diff
==============================================================================
--- pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/Decrypt.java (original)
+++ pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/Decrypt.java Tue Dec 29 13:36:13 2020
@@ -30,7 +30,6 @@ import org.apache.pdfbox.pdmodel.encrypt
import picocli.CommandLine;
import picocli.CommandLine.Command;
import picocli.CommandLine.Option;
-import picocli.CommandLine.Parameters;
/**
* This will read a document from the filesystem, decrypt it and and then write
@@ -61,12 +60,12 @@ public final class Decrypt implements Ca
@Option(names = "-password", arity="0..1", interactive = true, description = "the password for the PDF or certificate in keystore.")
private String password;
- @Parameters(paramLabel = "inputfile", index = "0", arity = "1", description = "the PDF file to decrypt.")
+ @Option(names = {"-i", "--input"}, description = "the PDF file to decrypt", required = true)
private File infile;
- @Parameters(paramLabel = "outputfile", index = "1", arity = "0..1", description = "the decrypted PDF file.")
+ @Option(names = {"-o", "--output"}, description = "the decrypted PDF file. If omitted the original file is overwritten.")
private File outfile;
-
+
/**
* This is the entry point for the application.
*
Modified: pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/Encrypt.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/Encrypt.java?rev=1884908&r1=1884907&r2=1884908&view=diff
==============================================================================
--- pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/Encrypt.java (original)
+++ pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/Encrypt.java Tue Dec 29 13:36:13 2020
@@ -38,7 +38,6 @@ import org.apache.pdfbox.pdmodel.encrypt
import picocli.CommandLine;
import picocli.CommandLine.Command;
import picocli.CommandLine.Option;
-import picocli.CommandLine.Parameters;
/**
* This will read a document from the filesystem, encrypt it and and then write
@@ -98,10 +97,10 @@ public final class Encrypt implements Ca
@Option(names = "-keyLength", description = "Key length in bits (valid values: 40, 128 or 256) (default: ${DEFAULT-VALUE})")
private int keyLength = 256;
- @Parameters(paramLabel = "inputfile", arity="1", description = "the PDF file to encyrpt.")
+ @Option(names = {"-i", "--input"}, description = "the PDF file to encrypt", required = true)
private File infile;
- @Parameters(paramLabel = "outputfile", index = "1", arity="0..1", description = "the encrypted PDF file. If left blank the original file will be overwritten.")
+ @Option(names = {"-o", "--output"}, description = "the encrypted PDF file. If omitted the original file is overwritten.")
private File outfile;
/**
Modified: pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ExportFDF.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ExportFDF.java?rev=1884908&r1=1884907&r2=1884908&view=diff
==============================================================================
--- pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ExportFDF.java (original)
+++ pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ExportFDF.java Tue Dec 29 13:36:13 2020
@@ -29,8 +29,7 @@ import org.apache.pdfbox.pdmodel.fdf.FDF
import picocli.CommandLine;
import picocli.CommandLine.Command;
-import picocli.CommandLine.Parameters;
-
+import picocli.CommandLine.Option;
/**
* This will take a PDF document and export the AcroForm form data to FDF.
@@ -44,12 +43,12 @@ public final class ExportFDF implements
@SuppressWarnings("squid:S106")
private static final PrintStream SYSERR = System.err;
- @Parameters(paramLabel = "inputfile", index = "0", arity = "1", description = "the PDF file to export.")
+ @Option(names = {"-i", "--input"}, description = "the PDF file to export", required = true)
private File infile;
- @Parameters(paramLabel = "outputfile", index = "1", arity = "0..1", description = "the FDF data file.")
+ @Option(names = {"-o", "--output"}, description = "the FDF data file", required = true)
private File outfile;
-
+
/**
* This is the entry point for the application.
*
Modified: pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ExportXFDF.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ExportXFDF.java?rev=1884908&r1=1884907&r2=1884908&view=diff
==============================================================================
--- pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ExportXFDF.java (original)
+++ pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ExportXFDF.java Tue Dec 29 13:36:13 2020
@@ -28,7 +28,7 @@ import org.apache.pdfbox.pdmodel.interac
import picocli.CommandLine;
import picocli.CommandLine.Command;
-import picocli.CommandLine.Parameters;
+import picocli.CommandLine.Option;
import org.apache.pdfbox.pdmodel.fdf.FDFDocument;
@@ -44,10 +44,10 @@ public final class ExportXFDF implements
@SuppressWarnings("squid:S106")
private static final PrintStream SYSERR = System.err;
- @Parameters(paramLabel = "inputfile", index = "0", arity = "1", description = "the PDF file to export.")
+ @Option(names = {"-i", "--input"}, description = "the PDF file to export", required = true)
private File infile;
- @Parameters(paramLabel = "outputfile", index = "1", arity = "0..1", description = "the XFDF data file.")
+ @Option(names = {"-o", "--output"}, description = "the XFDF data file", required = true)
private File outfile;
/**
Modified: pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ExtractImages.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ExtractImages.java?rev=1884908&r1=1884907&r2=1884908&view=diff
==============================================================================
--- pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ExtractImages.java (original)
+++ pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ExtractImages.java Tue Dec 29 13:36:13 2020
@@ -59,7 +59,6 @@ import org.apache.pdfbox.util.Vector;
import picocli.CommandLine;
import picocli.CommandLine.Command;
import picocli.CommandLine.Option;
-import picocli.CommandLine.Parameters;
/**
* Extracts the images from a PDF file.
@@ -93,7 +92,7 @@ public final class ExtractImages impleme
"original colorspace if possible.")
private boolean noColorConvert;
- @Parameters(paramLabel = "inputfile", index = "0", arity = "1", description = "the PDF file to decrypt.")
+ @Option(names = {"-i", "--input"}, description = "the PDF file", required = true)
private File infile;
private final Set<COSStream> seen = new HashSet<>();
Modified: pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ExtractText.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ExtractText.java?rev=1884908&r1=1884907&r2=1884908&view=diff
==============================================================================
--- pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ExtractText.java (original)
+++ pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ExtractText.java Tue Dec 29 13:36:13 2020
@@ -50,7 +50,6 @@ import org.apache.pdfbox.util.Matrix;
import picocli.CommandLine;
import picocli.CommandLine.Command;
import picocli.CommandLine.Option;
-import picocli.CommandLine.Parameters;
/**
* This is the main program that simply parses the pdf document and transforms it
@@ -107,10 +106,10 @@ public final class ExtractText implemen
@Option(names = "-startPage", description = "The first page to start extraction (1 based)")
private int startPage = 1;
- @Parameters(paramLabel = "inputfile", index = "0", arity = "1", description = "the PDF file to decrypt.")
+ @Option(names = {"-i", "--input"}, description = "the PDF file", required = true)
private File infile;
- @Parameters(paramLabel = "outputfile", index = "1", arity = "0..1", description = "the decrypted PDF file.")
+ @Option(names = {"-o", "--output"}, description = "the exported text file", required = true)
private File outfile;
/**
Modified: pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ImageToPDF.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ImageToPDF.java?rev=1884908&r1=1884907&r2=1884908&view=diff
==============================================================================
--- pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ImageToPDF.java (original)
+++ pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/ImageToPDF.java Tue Dec 29 13:36:13 2020
@@ -30,7 +30,6 @@ import org.apache.pdfbox.pdmodel.graphic
import picocli.CommandLine;
import picocli.CommandLine.Command;
import picocli.CommandLine.Option;
-import picocli.CommandLine.Parameters;
/**
* Create a PDF document from images.
@@ -56,10 +55,10 @@ public final class ImageToPDF implements
@Option(names = "-resize", description = "resize to page size")
private boolean resize = false;
- @Parameters(paramLabel = "image-file", arity="1", description = "the image files to convert.")
+ @Option(names = {"-i", "--input"}, description = "the image files to convert", paramLabel="image-file", required = true)
private File[] infiles;
- @Parameters(paramLabel = "outputfile", index = "1", description = "the generated PDF file.")
+ @Option(names = {"-o", "--output"}, description = "the generated PDF file", required = true)
private File outfile;
public static void main(String[] args)