org.apache.pdfbox.OverlayPDF Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pdfbox Show documentation
Show all versions of pdfbox Show documentation
The Apache PDFBox library is an open source Java tool for working with PDF documents.
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.pdfbox;
import java.util.HashMap;
import java.util.Map;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.pdfbox.pdfparser.BaseParser;
import org.apache.pdfbox.util.Overlay;
import org.apache.pdfbox.util.Overlay.Position;
/**
*
* Adds an overlay to an existing PDF document.
*
* Based on code contributed by Balazs Jerk.
*
*/
public class OverlayPDF
{
private static final Log LOG = LogFactory.getLog(BaseParser.class);
// Command line options
private static final String POSITION = "-position";
private static final String ODD = "-odd";
private static final String EVEN = "-even";
private static final String FIRST = "-first";
private static final String LAST = "-last";
private static final String PAGE = "-page";
private static final String USEALLPAGES = "-useAllPages";
private static final String NONSEQ = "-nonSeq";
/**
* This will overlay a document and write out the results.
*
* @param args command line arguments
* @throws Exception if something went wrong
*/
public static void main(final String[] args) throws Exception
{
Overlay overlayer = new Overlay();
Map specificPageOverlayFile = new HashMap();
boolean useNonSeqParser = false;
// input arguments
for (int i = 0; i < args.length; i++)
{
String arg = args[i].trim();
if (i == 0)
{
overlayer.setInputFile(arg);
}
else if (i == (args.length - 1))
{
overlayer.setOutputFile(arg);
}
else if (arg.equals(POSITION) && ((i + 1) < args.length))
{
if (Position.FOREGROUND.toString().equalsIgnoreCase(args[i + 1].trim()))
{
overlayer.setOverlayPosition(Position.FOREGROUND);
}
else if (Position.BACKGROUND.toString().equalsIgnoreCase(args[i + 1].trim()))
{
overlayer.setOverlayPosition(Position.BACKGROUND);
}
else
{
usage();
}
i += 1;
}
else if (arg.equals(ODD) && ((i + 1) < args.length))
{
overlayer.setOddPageOverlayFile(args[i + 1].trim());
i += 1;
}
else if (arg.equals(EVEN) && ((i + 1) < args.length))
{
overlayer.setEvenPageOverlayFile(args[i + 1].trim());
i += 1;
}
else if (arg.equals(FIRST) && ((i + 1) < args.length))
{
overlayer.setFirstPageOverlayFile(args[i + 1].trim());
i += 1;
}
else if (arg.equals(LAST) && ((i + 1) < args.length))
{
overlayer.setLastPageOverlayFile(args[i + 1].trim());
i += 1;
}
else if (arg.equals(USEALLPAGES) && ((i + 1) < args.length))
{
overlayer.setAllPagesOverlayFile(args[i + 1].trim());
i += 1;
}
else if (arg.equals(PAGE) && ((i + 2) < args.length) && (isInteger(args[i + 1].trim())))
{
specificPageOverlayFile.put(Integer.parseInt(args[i + 1].trim()), args[i + 2].trim());
i += 2;
}
else if( args[i].equals( NONSEQ ) )
{
useNonSeqParser = true;
}
else if (overlayer.getDefaultOverlayFile() == null)
{
overlayer.setDefaultOverlayFile(arg);
}
else
{
usage();
}
}
if (overlayer.getInputFile() == null || overlayer.getOutputFile() == null)
{
usage();
}
try
{
overlayer.overlay(specificPageOverlayFile,useNonSeqParser);
}
catch (Exception e)
{
LOG.error("Overlay failed: " + e.getMessage(), e);
throw e;
}
}
private static void usage()
{
StringBuilder message = new StringBuilder();
message.append("usage: java -jar pdfbox-app-x.y.z.jar OverlayPDF [OPTIONS] \n");
message.append(" input file\n");
message.append(" default overlay file\n");
message.append(" -odd overlay file used for odd pages\n");
message.append(" -even overlay file used for even pages\n");
message.append(" -first overlay file used for the first page\n");
message.append(" -last overlay file used for the last page\n");
message.append(" -useAllPages overlay file used for overlay, all pages"
+ " are used by simply repeating them\n");
message.append(" -page overlay file used for " +
"the given page number, may occur more than once\n");
message.append(" -position foreground|background where to put the overlay " +
"file: foreground or background\n");
message.append(" -nonSeq enables the new non-sequential parser\n");
message.append(" output file\n");
System.err.println(message.toString());
System.exit( 1 );
}
private static boolean isInteger(String str)
{
try
{
Integer.parseInt(str);
}
catch (NumberFormatException nfe)
{
return false;
}
return true;
}
}