pdfsam-1.1.4/ 0000755 0001750 0001750 00000000000 11365105226 012726 5 ustar twerner twerner pdfsam-1.1.4/pdfsam-split/ 0000755 0001750 0001750 00000000000 10725773606 015345 5 ustar twerner twerner pdfsam-1.1.4/pdfsam-split/ant/ 0000755 0001750 0001750 00000000000 10726034742 016117 5 ustar twerner twerner pdfsam-1.1.4/pdfsam-split/ant/build.properties 0000644 0001750 0001750 00000000741 11211203422 021315 0 ustar twerner twerner #where classes are compiled, jars distributed, javadocs created and release created
build.dir=f:/build
#libraries
libs.dir=F:/pdfsam/workspace-enhanced/pdfsam-maine/lib
pdfsam.release.jar.dir=f:/build/pdfsam-maine/release/jar
log4j.jar.name=log4j-1.2.15
dom4j.jar.name=dom4j-1.6.1
jaxen.jar.name=jaxen-1.1
pdfsam-console.jar.name=pdfsam-console-1.1.3e
pdfsam-split.jar.name=pdfsam-split-0.5.3
pdfsam-langpack.jar.name=pdfsam-langpack
pdfsam.jar.name=pdfsam-1.0.0e-b3
pdfsam-1.1.4/pdfsam-split/ant/build.xml 0000644 0001750 0001750 00000007272 11175612606 017750 0 ustar twerner twerner
Split plugin for pdfsam
pdfsam-1.1.4/pdfsam-split/apidocs/ 0000755 0001750 0001750 00000000000 11225360212 016744 5 ustar twerner twerner pdfsam-1.1.4/pdfsam-split/images/ 0000755 0001750 0001750 00000000000 10725773616 016613 5 ustar twerner twerner pdfsam-1.1.4/pdfsam-split/images/split.png 0000644 0001750 0001750 00000001124 10725773620 020445 0 ustar twerner twerner PNG
IHDR a bKGD e[ pHYs !3 tIME 5 IDAT8˥kq?w9ڀBT$D/v$b(,骜[!kUZ 48LsHsDo|x{BT\?Jh=Mp CSa iicc RXGi)w=u,{ ֳYm`O/DN.:0|;Y,eȪmA*7bӐUsDz,ܜ"M],/&w{՜i=ȩ x A#蕺ܝ)-C3Y`'~U[
GM/|p"|`v a4~#^e&>ƪD +ϝ lW* =% ٬V8}[MQvtbi2)om%CV;@?P.tN|u]
+SW ^|~txz':qFz΅[W
/ a IENDB` pdfsam-1.1.4/pdfsam-split/src/ 0000755 0001750 0001750 00000000000 10725773620 016130 5 ustar twerner twerner pdfsam-1.1.4/pdfsam-split/src/java/ 0000755 0001750 0001750 00000000000 10725773620 017051 5 ustar twerner twerner pdfsam-1.1.4/pdfsam-split/src/java/org/ 0000755 0001750 0001750 00000000000 10725773620 017640 5 ustar twerner twerner pdfsam-1.1.4/pdfsam-split/src/java/org/pdfsam/ 0000755 0001750 0001750 00000000000 10725773620 021112 5 ustar twerner twerner pdfsam-1.1.4/pdfsam-split/src/java/org/pdfsam/plugin/ 0000755 0001750 0001750 00000000000 10725773622 022412 5 ustar twerner twerner pdfsam-1.1.4/pdfsam-split/src/java/org/pdfsam/plugin/split/ 0000755 0001750 0001750 00000000000 10725773622 023545 5 ustar twerner twerner pdfsam-1.1.4/pdfsam-split/src/java/org/pdfsam/plugin/split/components/ 0000755 0001750 0001750 00000000000 11125404756 025724 5 ustar twerner twerner pdfsam-1.1.4/pdfsam-split/src/java/org/pdfsam/plugin/split/components/JSplitSizeCombo.java 0000644 0001750 0001750 00000005371 10726035162 031612 0 ustar twerner twerner /*
* Created on 30-Nov-2007
* Copyright (C) 2007 by Andrea Vacondio.
*
* This program 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 2 of the License.
* This program 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 this program;
* if not, write to the Free Software Foundation, Inc.,
* 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.pdfsam.plugin.split.components;
import java.math.BigDecimal;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import javax.swing.JComboBox;
import org.pdfsam.guiclient.configuration.Configuration;
import org.pdfsam.i18n.GettextResource;
/**
* Combo for the size selection
* @author Andrea Vacondio
*
*/
public class JSplitSizeCombo extends JComboBox {
private static final long serialVersionUID = 1342525636090510279L;
private Pattern pattern = Pattern.compile("^(\\d+[.[0-9]+]*)(\\s*)([KB||MB]+)", Pattern.CASE_INSENSITIVE );
public static final String KB = "KB";
public static final String MB = "MB";
public JSplitSizeCombo(){
init();
}
private void init(){
setEditable(true);
addItem("");
addItem("500 "+KB);
addItem("1 "+MB);
addItem("3 "+MB);
addItem("5 "+MB);
addItem("10 "+MB);
}
/**
* @return Bytes of the selected item
* @throws Exception
*/
public long getSelectedBytes() throws Exception{
long retVal = 0;
if(isValidSelectedItem()){
Matcher m = pattern.matcher((String)getSelectedItem());
m.reset();
m.matches();
BigDecimal value = new BigDecimal(m.group(1));
String unit = m.group(3);
if (KB.equals(unit.toUpperCase())){
value = value.multiply(new BigDecimal(1024));
}else if (MB.equals(unit.toUpperCase())){
value = value.multiply(new BigDecimal(1024*1024));
}else{
throw new Exception(GettextResource.gettext(Configuration.getInstance().getI18nResourceBundle(),"Invalid unit: ")+unit);
}
retVal = value.longValue();
}
return retVal;
}
/**
* @return true if the selected item is valid
*/
public boolean isValidSelectedItem(){
pattern.matcher((String)getSelectedItem()).reset();
return pattern.matcher((String)getSelectedItem()).matches();
}
/**
* @return if a not empty item is selected
*/
public boolean isSelectedItem(){
return (getSelectedItem()!=null && ((String)getSelectedItem()).trim().length()>0);
}
}
pdfsam-1.1.4/pdfsam-split/src/java/org/pdfsam/plugin/split/components/JSplitRadioButton.java 0000644 0001750 0001750 00000002471 10726035174 032153 0 ustar twerner twerner /*
* Created on 25-feb-2006
* Copyright (C) 2006 by Andrea Vacondio.
*
* This program 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 2 of the License.
* This program 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 this program;
* if not, write to the Free Software Foundation, Inc.,
* 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.pdfsam.plugin.split.components;
import javax.swing.JRadioButton;
/**
* This component is used to get the split type selected by the user
* @author Andrea Vacondio
*
*/
public class JSplitRadioButton extends JRadioButton {
private static final long serialVersionUID = 5210692149732974444L;
public JSplitRadioButton(String splitCommand) {
super();
this.setModel(new JSplitRadioButtonModel(splitCommand));
}
public String getSplitCommand(){
return ((JSplitRadioButtonModel)this.getModel()).getSplitCommand();
}
}
pdfsam-1.1.4/pdfsam-split/src/java/org/pdfsam/plugin/split/components/JBLevelCombo.java 0000644 0001750 0001750 00000014146 11162215046 031031 0 ustar twerner twerner /*
* Created on 27-DEC-2008
* Copyright (C) 2008 by Andrea Vacondio.
*
* This program 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 2 of the License.
* This program 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 this program;
* if not, write to the Free Software Foundation, Inc.,
* 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.pdfsam.plugin.split.components;
import java.awt.Dimension;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.util.List;
import javax.swing.Box;
import javax.swing.BoxLayout;
import javax.swing.JButton;
import javax.swing.JComboBox;
import javax.swing.JOptionPane;
import javax.swing.JPanel;
import org.apache.log4j.Logger;
import org.pdfsam.console.utils.PdfUtility;
import org.pdfsam.guiclient.commons.panels.JPdfSelectionPanel;
import org.pdfsam.guiclient.configuration.Configuration;
import org.pdfsam.guiclient.dto.PdfSelectionTableItem;
import org.pdfsam.i18n.GettextResource;
import com.lowagie.text.pdf.PdfReader;
import com.lowagie.text.pdf.RandomAccessFileOrArray;
import com.lowagie.text.pdf.SimpleBookmark;
/**
* Panel with the bookmarks level combo and the button to fill it
* @author Andrea Vacondio
*
*/
public class JBLevelCombo extends JPanel {
private static final long serialVersionUID = -1413124292303614507L;
private static final Logger log = Logger.getLogger(JBLevelCombo.class.getPackage().getName());
private JComboBox levelCombo;
private JButton fillCombo;
private JPdfSelectionPanel inputPanel;
private Thread filler = null;
public JBLevelCombo(JPdfSelectionPanel inputPanel) {
this.inputPanel = inputPanel;
init();
}
private void init(){
levelCombo = new JComboBox();
levelCombo.setPreferredSize(new Dimension(45,20));
fillCombo = new JButton();
fillCombo.setText("< "+GettextResource.gettext(Configuration.getInstance().getI18nResourceBundle(),"Fill from document"));
levelCombo.setEditable(true);
fillCombo.addActionListener(new ActionListener() {
public void actionPerformed(ActionEvent e) {
try {
PdfSelectionTableItem[] items = inputPanel.getTableRows();
if (items != null && items.length == 1) {
if(filler == null){
filler = new Thread(new FillThread(items[0]));
filler.start();
}
}
else {
JOptionPane.showMessageDialog(getParent(), GettextResource.gettext(Configuration.getInstance()
.getI18nResourceBundle(), "Please select a pdf document."), GettextResource.gettext(
Configuration.getInstance().getI18nResourceBundle(), "Warning"), JOptionPane.WARNING_MESSAGE);
}
} catch (Exception ex) {
log.error(GettextResource.gettext(Configuration.getInstance().getI18nResourceBundle(), "Error: "), ex);
}
}
});
setLayout(new BoxLayout(this, BoxLayout.LINE_AXIS));
add(Box.createHorizontalGlue());
add(levelCombo);
add(Box.createRigidArea(new Dimension(10, 0)));
add(fillCombo);
}
/**
* Fills the levels combo
* @author Andrea Vacondio
*
*/
private class FillThread implements Runnable {
private PdfSelectionTableItem item;
/**
* @param item
*/
public FillThread(PdfSelectionTableItem item) {
super();
this.item = item;
}
public void run() {
fillCombo.setEnabled(false);
fillCombo.setToolTipText(GettextResource.gettext(Configuration.getInstance().getI18nResourceBundle(), "Getting bookmarks max depth"));
try {
levelCombo.removeAllItems();
byte[] password = null;
if((item.getPassword()) != null && (item.getPassword()).length()>0){
password = item.getPassword().getBytes();
}
PdfReader pdfReader = new PdfReader(new RandomAccessFileOrArray(item.getInputFile().getAbsolutePath()),password);
pdfReader.consolidateNamedDestinations();
List bookmarks = SimpleBookmark.getBookmark(pdfReader);
ByteArrayOutputStream out = new ByteArrayOutputStream();
SimpleBookmark.exportToXML(bookmarks, out, "UTF-8", false);
ByteArrayInputStream input = new ByteArrayInputStream(out.toByteArray());
int maxDepth = PdfUtility.getMaxBookmarksDepth(input);
for(int i = 1; i<=maxDepth; i++){
levelCombo.addItem(i+"");
}
} catch (Throwable t) {
log.error(GettextResource.gettext(Configuration.getInstance().getI18nResourceBundle(), "Error: "), t);
} finally {
fillCombo.setEnabled(true);
fillCombo.setToolTipText(null);
filler = null;
}
}
}
public void resetComponent(){
levelCombo.removeAllItems();
setEnabled(isEnabled());
}
/**
* @return selected index
* @see javax.swing.JComboBox#getSelectedIndex()
*/
public int getSelectedIndex() {
return levelCombo.getSelectedIndex();
}
/**
* @return selected item
* @see javax.swing.JComboBox#getSelectedItem()
*/
public Object getSelectedItem() {
return levelCombo.getSelectedItem();
}
/**
*
* @see javax.swing.JComboBox#removeAllItems()
*/
public void removeAllItems() {
levelCombo.removeAllItems();
}
/**
* @param anObject
* @see javax.swing.JComboBox#setSelectedItem(java.lang.Object)
*/
public void setSelectedItem(Object anObject) {
levelCombo.setSelectedItem(anObject);
}
/* (non-Javadoc)
* @see javax.swing.JComponent#setEnabled(boolean)
*/
public void setEnabled(boolean enabled) {
super.setEnabled(enabled);
levelCombo.setEnabled(enabled);
fillCombo.setEnabled(enabled);
}
/**
* @return the levelCombo
*/
public JComboBox getLevelCombo() {
return levelCombo;
}
/**
* @return the fillCombo
*/
public JButton getFillCombo() {
return fillCombo;
}
/* (non-Javadoc)
* @see javax.swing.JComponent#requestFocus()
*/
public void requestFocus() {
levelCombo.requestFocus();
}
}
pdfsam-1.1.4/pdfsam-split/src/java/org/pdfsam/plugin/split/components/JSplitRadioButtonModel.java 0000644 0001750 0001750 00000002750 10725771640 033140 0 ustar twerner twerner /*
* Created on 02-Dec-2007
* Copyright (C) 2007 by Andrea Vacondio.
*
* This program 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 2 of the License.
* This program 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 this program;
* if not, write to the Free Software Foundation, Inc.,
* 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.pdfsam.plugin.split.components;
import javax.swing.JToggleButton.ToggleButtonModel;
/**
* Model for the split radio buttons
* @author Andrea Vacondio
*
*/
public class JSplitRadioButtonModel extends ToggleButtonModel {
private static final long serialVersionUID = -541344769909895211L;
private String splitCommand;
/**
*
*/
public JSplitRadioButtonModel(String splitCommand) {
super();
this.splitCommand = splitCommand;
}
/**
* @return the splitCommand
*/
public String getSplitCommand() {
return splitCommand;
}
/**
* @param splitCommand the splitCommand to set
*/
public void setSplitCommand(String splitCommand) {
this.splitCommand = splitCommand;
}
}
pdfsam-1.1.4/pdfsam-split/src/java/org/pdfsam/plugin/split/GUI/ 0000755 0001750 0001750 00000000000 10725773622 024171 5 ustar twerner twerner pdfsam-1.1.4/pdfsam-split/src/java/org/pdfsam/plugin/split/GUI/SplitMainGUI.java 0000644 0001750 0001750 00000141035 11211203054 027257 0 ustar twerner twerner /*
* Created on 17-Feb-2006
* Copyright (C) 2006 by Andrea Vacondio.
*
* This program 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 2 of the License.
* This program 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 this program;
* if not, write to the Free Software Foundation, Inc.,
* 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.pdfsam.plugin.split.GUI;
import java.awt.Component;
import java.awt.Container;
import java.awt.Dimension;
import java.awt.FocusTraversalPolicy;
import java.awt.GridLayout;
import java.awt.Insets;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.io.File;
import java.util.LinkedList;
import javax.swing.BorderFactory;
import javax.swing.ButtonGroup;
import javax.swing.ButtonModel;
import javax.swing.JButton;
import javax.swing.JCheckBox;
import javax.swing.JFileChooser;
import javax.swing.JLabel;
import javax.swing.JOptionPane;
import javax.swing.JPanel;
import javax.swing.JRadioButton;
import javax.swing.JTextField;
import javax.swing.SpringLayout;
import org.apache.log4j.Logger;
import org.dom4j.Element;
import org.dom4j.Node;
import org.pdfsam.console.business.dto.commands.AbstractParsedCommand;
import org.pdfsam.console.business.dto.commands.MixParsedCommand;
import org.pdfsam.console.business.dto.commands.SplitParsedCommand;
import org.pdfsam.guiclient.business.listeners.EnterDoClickListener;
import org.pdfsam.guiclient.commons.business.SoundPlayer;
import org.pdfsam.guiclient.commons.business.WorkExecutor;
import org.pdfsam.guiclient.commons.business.WorkThread;
import org.pdfsam.guiclient.commons.business.listeners.CompressCheckBoxItemListener;
import org.pdfsam.guiclient.commons.components.CommonComponentsFactory;
import org.pdfsam.guiclient.commons.components.JPdfVersionCombo;
import org.pdfsam.guiclient.commons.models.AbstractPdfSelectionTableModel;
import org.pdfsam.guiclient.commons.models.SimplePdfSelectionTableModel;
import org.pdfsam.guiclient.commons.panels.JPdfSelectionPanel;
import org.pdfsam.guiclient.configuration.Configuration;
import org.pdfsam.guiclient.dto.PdfSelectionTableItem;
import org.pdfsam.guiclient.dto.StringItem;
import org.pdfsam.guiclient.exceptions.LoadJobException;
import org.pdfsam.guiclient.exceptions.SaveJobException;
import org.pdfsam.guiclient.gui.components.JHelpLabel;
import org.pdfsam.guiclient.plugins.interfaces.AbstractPlugablePanel;
import org.pdfsam.guiclient.utils.DialogUtility;
import org.pdfsam.i18n.GettextResource;
import org.pdfsam.plugin.split.components.JBLevelCombo;
import org.pdfsam.plugin.split.components.JSplitRadioButton;
import org.pdfsam.plugin.split.components.JSplitRadioButtonModel;
import org.pdfsam.plugin.split.components.JSplitSizeCombo;
import org.pdfsam.plugin.split.listeners.RadioListener;
/**
* Plugable JPanel provides a GUI for split functions.
* @author Andrea Vacondio
* @see javax.swing.JPanel
*/
public class SplitMainGUI extends AbstractPlugablePanel{
private static final long serialVersionUID = -5907189950338614835L;
private static final Logger log = Logger.getLogger(SplitMainGUI.class.getPackage().getName());
private JTextField outPrefixText = CommonComponentsFactory.getInstance().createTextField(CommonComponentsFactory.PREFIX_TEXT_FIELD_TYPE);
private SpringLayout outputPanelLayout;
private SpringLayout destinationPanelLayout;
private JTextField destinationFolderText = CommonComponentsFactory.getInstance().createTextField(CommonComponentsFactory.DESTINATION_TEXT_FIELD_TYPE);
private JTextField thisPageTextField = CommonComponentsFactory.getInstance().createTextField(CommonComponentsFactory.SIMPLE_TEXT_FIELD_TYPE);
private JTextField nPagesTextField = CommonComponentsFactory.getInstance().createTextField(CommonComponentsFactory.SIMPLE_TEXT_FIELD_TYPE);
private JHelpLabel checksHelpLabel;
private SpringLayout optionsPaneLayout;
private JHelpLabel prefixHelpLabel;
private JHelpLabel destinationHelpLabel;
private SpringLayout splitSpringLayout;
private String splitType = "";
private JPdfVersionCombo versionCombo = new JPdfVersionCombo(true);
private Configuration config;
private JPdfSelectionPanel selectionPanel = new JPdfSelectionPanel(JPdfSelectionPanel.SINGLE_SELECTABLE_FILE, SimplePdfSelectionTableModel.DEFAULT_SHOWED_COLUMNS_NUMBER);
private JSplitSizeCombo splitSizeCombo = new JSplitSizeCombo();
private JBLevelCombo bLevelCombo = new JBLevelCombo(selectionPanel);
//file_chooser
private JFileChooser browseDestFileChooser = null;
//button
private final JButton browseDestButton = CommonComponentsFactory.getInstance().createButton(CommonComponentsFactory.BROWSE_BUTTON_TYPE);
private final JButton runButton = CommonComponentsFactory.getInstance().createButton(CommonComponentsFactory.RUN_BUTTON_TYPE);
//key_listeners
private final EnterDoClickListener browsedEnterkeyListener = new EnterDoClickListener(browseDestButton);
private final EnterDoClickListener runEnterkeyListener = new EnterDoClickListener(runButton);
//split_radio
private final JSplitRadioButton burstRadio = new JSplitRadioButton(SplitParsedCommand.S_BURST);
private final JSplitRadioButton everyNRadio = new JSplitRadioButton(SplitParsedCommand.S_NSPLIT);
private final JSplitRadioButton evenRadio = new JSplitRadioButton(SplitParsedCommand.S_EVEN);
private final JSplitRadioButton oddRadio = new JSplitRadioButton(SplitParsedCommand.S_ODD);
private final JSplitRadioButton thisPageRadio = new JSplitRadioButton(SplitParsedCommand.S_SPLIT);
private final JSplitRadioButton sizeRadio = new JSplitRadioButton(SplitParsedCommand.S_SIZE);
private final JSplitRadioButton bookmarksLevel = new JSplitRadioButton(SplitParsedCommand.S_BLEVEL);
private RadioListener radioListener;
//radio
private final JRadioButton sameAsSourceRadio = new JRadioButton();
private final JRadioButton chooseAFolderRadio = new JRadioButton();
private ButtonGroup splitOptionsRadioGroup;
//checks
private final JCheckBox overwriteCheckbox = CommonComponentsFactory.getInstance().createCheckBox(CommonComponentsFactory.OVERWRITE_CHECKBOX_TYPE);
private final JCheckBox outputCompressedCheck = CommonComponentsFactory.getInstance().createCheckBox(CommonComponentsFactory.COMPRESS_CHECKBOX_TYPE);
//focus policy
private final SplitFocusPolicy splitFocusPolicy = new SplitFocusPolicy();
//panels
private final JPanel splitOptionsPanel = new JPanel();
private final JPanel destinationPanel = new JPanel();
private final JPanel outputOptionsPanel = new JPanel();
private final JPanel splitTypesPanel = new JPanel();
//labels
private final JLabel outPrefixLabel = new JLabel();
private final JLabel outputVersionLabel = CommonComponentsFactory.getInstance().createLabel(CommonComponentsFactory.PDF_VERSION_LABEL);
private final String PLUGIN_AUTHOR = "Andrea Vacondio";
private final String PLUGIN_VERSION = "0.5.3";
/**
* Constructor
*
*/
public SplitMainGUI() {
super();
initialize();
}
private void initialize() {
config = Configuration.getInstance();
setPanelIcon("/images/split.png");
setPreferredSize(new Dimension(500,555));
//
splitSpringLayout = new SpringLayout();
setLayout(splitSpringLayout);
add(selectionPanel);
//SPLIT_SECTION
optionsPaneLayout = new SpringLayout();
splitOptionsPanel.setLayout(optionsPaneLayout);
splitOptionsPanel.setBorder(BorderFactory.createTitledBorder(GettextResource.gettext(config.getI18nResourceBundle(),"Split options")));
add(splitOptionsPanel);
GridLayout splitOptionsLayout = new GridLayout(0,3,5,5);
splitTypesPanel.setLayout(splitOptionsLayout);
burstRadio.setText(GettextResource.gettext(config.getI18nResourceBundle(),"Burst (split into single pages)"));
everyNRadio.setText(GettextResource.gettext(config.getI18nResourceBundle(),"Split every \"n\" pages"));
evenRadio.setText(GettextResource.gettext(config.getI18nResourceBundle(),"Split even pages"));
oddRadio.setText(GettextResource.gettext(config.getI18nResourceBundle(),"Split odd pages"));
nPagesTextField.setEnabled(false);
thisPageRadio.setText(GettextResource.gettext(config.getI18nResourceBundle(),"Split after these pages"));
sizeRadio.setText(GettextResource.gettext(config.getI18nResourceBundle(),"Split at this size"));
bookmarksLevel.setText(GettextResource.gettext(config.getI18nResourceBundle(),"Split by bookmarks level"));
thisPageTextField.setEnabled(false);
splitSizeCombo.setEnabled(false);
bLevelCombo.setEnabled(false);
splitTypesPanel.add(burstRadio);
splitTypesPanel.add(thisPageRadio);
splitTypesPanel.add(thisPageTextField);
splitTypesPanel.add(evenRadio);
splitTypesPanel.add(everyNRadio);
splitTypesPanel.add(nPagesTextField);
splitTypesPanel.add(oddRadio);
splitTypesPanel.add(sizeRadio);
splitTypesPanel.add(splitSizeCombo);
splitTypesPanel.add(new JLabel());
splitTypesPanel.add(bookmarksLevel);
splitTypesPanel.add(bLevelCombo);
splitOptionsPanel.add(splitTypesPanel);
String helpText =
""+GettextResource.gettext(config.getI18nResourceBundle(),"Split options")+"
" +
"
"+GettextResource.gettext(config.getI18nResourceBundle(),"Burst")+": "+GettextResource.gettext(config.getI18nResourceBundle(),"Explode the pdf document into single pages")+".
" +
"
"+GettextResource.gettext(config.getI18nResourceBundle(),"Split every \"n\" pages")+": "+GettextResource.gettext(config.getI18nResourceBundle(),"Split the document every \"n\" pages")+".
" +
"
"+GettextResource.gettext(config.getI18nResourceBundle(),"Split even pages")+": "+GettextResource.gettext(config.getI18nResourceBundle(),"Split the document every even page")+".
" +
"
"+GettextResource.gettext(config.getI18nResourceBundle(),"Split odd pages")+": "+GettextResource.gettext(config.getI18nResourceBundle(),"Split the document every odd page")+".
" +
"
"+GettextResource.gettext(config.getI18nResourceBundle(),"Split after these pages")+": "+GettextResource.gettext(config.getI18nResourceBundle(),"Split the document after page numbers (num1-num2-num3..)")+".
" +
"
"+GettextResource.gettext(config.getI18nResourceBundle(),"Split at this size")+": "+GettextResource.gettext(config.getI18nResourceBundle(),"Split the document in files of the given size (roughly)")+".
" +
"
"+GettextResource.gettext(config.getI18nResourceBundle(),"Split by bookmarks level")+": "+GettextResource.gettext(config.getI18nResourceBundle(),"Split the document at pages referred by bookmarks of the given level")+".
" +
"
";
checksHelpLabel = new JHelpLabel(helpText, true);
splitOptionsPanel.add(checksHelpLabel);
//END_SPLIT_SECTION
//RADIO_LISTENERS
/*This listeners enable or disable text field based on what you select*/
radioListener = new RadioListener(this, nPagesTextField, thisPageTextField, splitSizeCombo, bLevelCombo);
burstRadio.setActionCommand(RadioListener.DISABLE_ALL);
burstRadio.addActionListener(radioListener);
everyNRadio.setActionCommand(RadioListener.ENABLE_FIRST);
everyNRadio.addActionListener(radioListener);
evenRadio.setActionCommand(RadioListener.DISABLE_ALL);
evenRadio.addActionListener(radioListener);
oddRadio.setActionCommand(RadioListener.DISABLE_ALL);
oddRadio.addActionListener(radioListener);
thisPageRadio.setActionCommand(RadioListener.ENABLE_SECOND);
thisPageRadio.addActionListener(radioListener);
sizeRadio.setActionCommand(RadioListener.ENABLE_THIRD);
sizeRadio.addActionListener(radioListener);
bookmarksLevel.setActionCommand(RadioListener.ENABLE_FOURTH);
bookmarksLevel.addActionListener(radioListener);
//END_RADIO_LISTENERS
//DESTINATION_PANEL
destinationPanelLayout = new SpringLayout();
destinationPanel.setLayout(destinationPanelLayout);
destinationPanel.setBorder(BorderFactory.createTitledBorder(GettextResource.gettext(config.getI18nResourceBundle(),"Destination folder")));
add(destinationPanel);
//END_DESTINATION_PANEL
//DESTINATION_RADIOS
sameAsSourceRadio.setText(GettextResource.gettext(config.getI18nResourceBundle(),"Same as source"));
destinationPanel.add(sameAsSourceRadio);
chooseAFolderRadio.setSelected(true);
chooseAFolderRadio.setText(GettextResource.gettext(config.getI18nResourceBundle(),"Choose a folder"));
destinationPanel.add(chooseAFolderRadio);
//END_DESTINATION_RADIOS
//RADIOGROUP
splitOptionsRadioGroup = new ButtonGroup();
splitOptionsRadioGroup.add(burstRadio);
splitOptionsRadioGroup.add(everyNRadio);
splitOptionsRadioGroup.add(evenRadio);
splitOptionsRadioGroup.add(oddRadio);
splitOptionsRadioGroup.add(thisPageRadio);
splitOptionsRadioGroup.add(sizeRadio);
splitOptionsRadioGroup.add(bookmarksLevel);
final ButtonGroup outputRadioGroup = new ButtonGroup();
outputRadioGroup.add(sameAsSourceRadio);
outputRadioGroup.add(chooseAFolderRadio);
//END_RADIOGROUP
destinationPanel.add(destinationFolderText);
destinationPanel.add(overwriteCheckbox);
destinationPanel.add(outputCompressedCheck);
outputCompressedCheck.addItemListener(new CompressCheckBoxItemListener(versionCombo));
outputCompressedCheck.setSelected(true);
destinationPanel.add(versionCombo);
destinationPanel.add(outputVersionLabel);
browseDestButton.addActionListener(new ActionListener() {
public void actionPerformed(ActionEvent e) {
if(browseDestFileChooser==null){
browseDestFileChooser = new JFileChooser(Configuration.getInstance().getDefaultWorkingDir());
browseDestFileChooser.setFileSelectionMode(JFileChooser.DIRECTORIES_ONLY);
}
File chosenFile = null;
if(destinationFolderText.getText().length()>0){
browseDestFileChooser.setCurrentDirectory(new File(destinationFolderText.getText()));
}
if (browseDestFileChooser.showOpenDialog(browseDestButton.getParent()) == JFileChooser.APPROVE_OPTION){
chosenFile = browseDestFileChooser.getSelectedFile();
}
//write the destination in text field
if (chosenFile != null && chosenFile.isDirectory()){
try{
destinationFolderText.setText(chosenFile.getAbsolutePath());
}
catch (Exception ex){
log.error(GettextResource.gettext(config.getI18nResourceBundle(),"Error: "), ex);
}
}
}
});
destinationPanel.add(browseDestButton);
//HELP_LABEL_DESTINATION
String helpTextDest =
""+GettextResource.gettext(config.getI18nResourceBundle(),"Destination output directory")+"" +
"
"+GettextResource.gettext(config.getI18nResourceBundle(),"Use the same output folder as the input file or choose a folder.")+"
"+
"
"+GettextResource.gettext(config.getI18nResourceBundle(),"To choose a folder browse or enter the full path to the destination output directory.")+"
"+
"
"+GettextResource.gettext(config.getI18nResourceBundle(),"Check the box if you want to overwrite the output files if they already exist.")+"
"+
"
"+GettextResource.gettext(config.getI18nResourceBundle(),"Check the box if you want compressed output files.")+" "+GettextResource.gettext(config.getI18nResourceBundle(),"PDF version 1.5 or above.")+"
"+
"
"+GettextResource.gettext(config.getI18nResourceBundle(),"Set the pdf version of the ouput document.")+"
"+GettextResource.gettext(config.getI18nResourceBundle(),"If it contains \"[CURRENTPAGE]\", \"[TIMESTAMP]\", \"[FILENUMBER]\" or \"[BOOKMARK_NAME]\" it performs variable substitution.")+"
"+GettextResource.gettext(config.getI18nResourceBundle(),"If it doesn't contain \"[CURRENTPAGE]\", \"[TIMESTAMP]\" or \"[FILENUMBER]\" it generates oldstyle output file names.")+"
"+
"";
prefixHelpLabel = new JHelpLabel(helpTextPrefix, true);
outputOptionsPanel.add(prefixHelpLabel);
//END_HELP_LABEL_PREFIX
//RUN_BUTTON
//listener
runButton.addActionListener(new ActionListener() {
public void actionPerformed(ActionEvent e) {
if (WorkExecutor.getInstance().getRunningThreads() > 0 || selectionPanel.isAdding()){
log.info(GettextResource.gettext(config.getI18nResourceBundle(),"Please wait while all files are processed.."));
return;
}
final LinkedList args = new LinkedList();
try{
PdfSelectionTableItem item = null;
PdfSelectionTableItem[] items = selectionPanel.getTableRows();
if(items != null && items.length == 1){
item = items[0];
args.add("-"+SplitParsedCommand.F_ARG);
String f = item.getInputFile().getAbsolutePath();
if((item.getPassword()) != null && (item.getPassword()).length()>0){
log.debug(GettextResource.gettext(config.getI18nResourceBundle(),"Found a password for input file."));
f +=":"+item.getPassword();
}
args.add(f);
args.add("-"+SplitParsedCommand.P_ARG);
args.add(outPrefixText.getText());
args.add("-"+SplitParsedCommand.S_ARG);
args.add(splitType);
//check if is needed page option
if (splitType.equals(SplitParsedCommand.S_SPLIT)){
args.add("-"+SplitParsedCommand.N_ARG);
args.add(thisPageTextField.getText());
}else if (splitType.equals(SplitParsedCommand.S_NSPLIT)){
args.add("-"+SplitParsedCommand.N_ARG);
args.add(nPagesTextField.getText());
}else if (splitType.equals(SplitParsedCommand.S_SIZE)){
args.add("-"+SplitParsedCommand.B_ARG);
if(splitSizeCombo.isSelectedItem() && splitSizeCombo.isValidSelectedItem()){
args.add(Long.toString(splitSizeCombo.getSelectedBytes()));
}else{
throw new Exception(GettextResource.gettext(config.getI18nResourceBundle(),"Invalid split size"));
}
} else if (splitType.equals(SplitParsedCommand.S_BLEVEL)){
args.add("-"+SplitParsedCommand.BL_ARG);
args.add((String)bLevelCombo.getSelectedItem());
}
args.add("-"+SplitParsedCommand.O_ARG);
//check radio for output options
if (sameAsSourceRadio.isSelected()){
if(item != null){
args.add(item.getInputFile().getParent());
}
}else{
if(destinationFolderText.getText()==null || destinationFolderText.getText().length()==0){
String suggestedDir = Configuration.getInstance().getDefaultWorkingDir();
if(suggestedDir != null){
int chosenOpt = DialogUtility.showConfirmOuputLocationDialog(getParent(),suggestedDir);
if(JOptionPane.YES_OPTION == chosenOpt){
destinationFolderText.setText(suggestedDir);
}else if(JOptionPane.CANCEL_OPTION == chosenOpt){
return;
}
}
}
args.add(destinationFolderText.getText());
}
if (overwriteCheckbox.isSelected()) args.add("-"+SplitParsedCommand.OVERWRITE_ARG);
if (outputCompressedCheck.isSelected()) args.add("-"+SplitParsedCommand.COMPRESSED_ARG);
args.add("-"+MixParsedCommand.PDFVERSION_ARG);
if(JPdfVersionCombo.SAME_AS_SOURCE.equals(((StringItem)versionCombo.getSelectedItem()).getId())){
StringItem minItem = versionCombo.getMinItem();
String currentPdfVersion = Character.toString(item.getPdfVersion());
if(minItem != null){
if(Integer.parseInt(currentPdfVersion) < Integer.parseInt(minItem.getId())){
if(JOptionPane.YES_OPTION != JOptionPane.showConfirmDialog(getParent(),
GettextResource.gettext(config.getI18nResourceBundle(),"The lowest available pdf version is ")+minItem.getDescription()+".\n"+GettextResource.gettext(config.getI18nResourceBundle(),"You selected a lower output pdf version, continue anyway ?"),
GettextResource.gettext(config.getI18nResourceBundle(),"Pdf version conflict"),
JOptionPane.YES_NO_OPTION,
JOptionPane.WARNING_MESSAGE)){
return;
}
}
}
args.add(currentPdfVersion);
}else{
args.add(((StringItem)versionCombo.getSelectedItem()).getId());
}
args.add(AbstractParsedCommand.COMMAND_SPLIT);
final String[] myStringArray = (String[])args.toArray(new String[args.size()]);
WorkExecutor.getInstance().execute(new WorkThread(myStringArray));
}else{
JOptionPane.showMessageDialog(getParent(),
GettextResource.gettext(config.getI18nResourceBundle(),"Please select a pdf document."),
GettextResource.gettext(config.getI18nResourceBundle(),"Warning"),
JOptionPane.WARNING_MESSAGE);
}
}catch(Exception ex){
log.error(GettextResource.gettext(config.getI18nResourceBundle(),"Error: "), ex);
SoundPlayer.getInstance().playErrorSound();
}
}
});
runButton.setToolTipText(GettextResource.gettext(config.getI18nResourceBundle(),"Split selected file"));
runButton.setMargin(new Insets(5, 5, 5, 5));
runButton.setSize(new Dimension(88,25));
add(runButton);
//END_RUN_BUTTON
//RADIO_LISTENERS
sameAsSourceRadio.addActionListener(new ActionListener() {
public void actionPerformed(ActionEvent e) {
destinationFolderText.setEnabled(false);
browseDestButton.setEnabled(false);
}
});
chooseAFolderRadio.addActionListener(new ActionListener() {
public void actionPerformed(ActionEvent e) {
destinationFolderText.setEnabled(true);
browseDestButton.setEnabled(true);
}
});
//END_RADIO_LISTENERS
//ENTER_KEY_LISTENERS
browseDestButton.addKeyListener(browsedEnterkeyListener);
runButton.addKeyListener(runEnterkeyListener);
outPrefixText.addKeyListener(runEnterkeyListener);
//END_ENTER_KEY_LISTENERS
setLayout();
}
/**
* @return Returns the Plugin author.
*/
public String getPluginAuthor() {
return PLUGIN_AUTHOR;
}
/**
* @return Returns the Plugin name.
*/
public String getPluginName() {
return GettextResource.gettext(config.getI18nResourceBundle(),"Split");
}
/**
* @return Returns the version.
*/
public String getVersion() {
return PLUGIN_VERSION;
}
public Node getJobNode(Node arg0, boolean savePasswords) throws SaveJobException {
try{
if (arg0 != null){
Element fileSource = ((Element)arg0).addElement("source");
PdfSelectionTableItem[] items = selectionPanel.getTableRows();
if(items != null && items.length>0){
fileSource.addAttribute("value",items[0].getInputFile().getAbsolutePath());
if(savePasswords){
fileSource.addAttribute("password",items[0].getPassword());
}
}
Element splitOption = ((Element)arg0).addElement("split_option");
if(splitOptionsRadioGroup.getSelection() != null){
splitOption.addAttribute("value",((JSplitRadioButtonModel)splitOptionsRadioGroup.getSelection()).getSplitCommand());
}
Element splitNpages = ((Element)arg0).addElement("npages");
splitNpages.addAttribute("value", nPagesTextField.getText());
Element splitThispage = ((Element)arg0).addElement("thispage");
splitThispage.addAttribute("value", thisPageTextField.getText());
Element splitSize = ((Element)arg0).addElement("splitsize");
splitSize.addAttribute("value", splitSizeCombo.getSelectedItem().toString());
Element bookLevel = ((Element)arg0).addElement("bookmarkslevel");
if(bLevelCombo.getSelectedItem() != null){
bookLevel.addAttribute("value", bLevelCombo.getSelectedItem().toString());
}
Element fileDestination = ((Element)arg0).addElement("destination");
fileDestination.addAttribute("value", destinationFolderText.getText());
Element filePrefix = ((Element)arg0).addElement("prefix");
filePrefix.addAttribute("value", outPrefixText.getText());
Element file_overwrite = ((Element)arg0).addElement("overwrite");
file_overwrite.addAttribute("value", overwriteCheckbox.isSelected()?TRUE:FALSE);
Element fileCompress = ((Element)arg0).addElement("compressed");
fileCompress.addAttribute("value", outputCompressedCheck.isSelected()?TRUE:FALSE);
Element pdfVersion = ((Element)arg0).addElement("pdfversion");
pdfVersion.addAttribute("value", ((StringItem)versionCombo.getSelectedItem()).getId());
}
return arg0;
}
catch (Exception ex){
throw new SaveJobException(ex);
}
}
public void loadJobNode(Node arg0) throws LoadJobException {
if(arg0!=null){
try{
resetPanel();
Node fileSource = (Node) arg0.selectSingleNode("source/@value");
if (fileSource != null && fileSource.getText().length()>0){
Node filePwd = (Node) arg0.selectSingleNode("source/@password");
String password = null;
if (filePwd != null && filePwd.getText().length()>0){
password = filePwd.getText();
}
selectionPanel.getLoader().addFile(new File(fileSource.getText()), password);
}
Node splitOption = (Node) arg0.selectSingleNode("split_option/@value");
if (splitOption != null){
if(splitOption.getText().equals(burstRadio.getSplitCommand())) burstRadio.doClick();
else if(splitOption.getText().equals(everyNRadio.getSplitCommand())) everyNRadio.doClick();
else if(splitOption.getText().equals(evenRadio.getSplitCommand())) evenRadio.doClick();
else if(splitOption.getText().equals(oddRadio.getSplitCommand())) oddRadio.doClick();
else if(splitOption.getText().equals(thisPageRadio.getSplitCommand())) thisPageRadio.doClick();
else if(splitOption.getText().equals(sizeRadio.getSplitCommand())) sizeRadio.doClick();
else if(splitOption.getText().equals(bookmarksLevel.getSplitCommand())) bookmarksLevel.doClick();
}
Node splitNpages = (Node) arg0.selectSingleNode("npages/@value");
if (splitNpages != null){
nPagesTextField.setText(splitNpages.getText());
}
Node splitThispage = (Node) arg0.selectSingleNode("thispage/@value");
if (splitThispage != null){
thisPageTextField.setText(splitThispage.getText());
}
Node splitSize = (Node) arg0.selectSingleNode("splitsize/@value");
if (splitSize != null){
splitSizeCombo.setSelectedItem(splitSize.getText());
}
Node bookLevel = (Node) arg0.selectSingleNode("bookmarkslevel/@value");
if (bookLevel != null){
bLevelCombo.setSelectedItem(bookLevel.getText());
}
Node fileDestination = (Node) arg0.selectSingleNode("destination/@value");
if (fileDestination != null && fileDestination.getText().length()>0){
destinationFolderText.setText(fileDestination.getText());
chooseAFolderRadio.doClick();
}else{
sameAsSourceRadio.doClick();
}
Node fileOverwrite = (Node) arg0.selectSingleNode("overwrite/@value");
if (fileOverwrite != null){
overwriteCheckbox.setSelected(TRUE.equals(fileOverwrite.getText()));
}
Node fileCompressed = (Node) arg0.selectSingleNode("compressed/@value");
if (fileCompressed != null && TRUE.equals(fileCompressed.getText())){
outputCompressedCheck.doClick();
}
Node filePrefix = (Node) arg0.selectSingleNode("prefix/@value");
if (filePrefix != null){
outPrefixText.setText(filePrefix.getText());
}
Node pdfVersion = (Node) arg0.selectSingleNode("pdfversion/@value");
if (pdfVersion != null){
for (int i = 0; i0){
if(DISABLE_ALL.equals(e.getActionCommand())){
first.setEnabled(false);
second.setEnabled(false);
third.setEnabled(false);
fourth.setEnabled(false);
}else if(ENABLE_FIRST.equals(e.getActionCommand())){
first.setEnabled(true);
second.setEnabled(false);
third.setEnabled(false);
fourth.setEnabled(false);
first.requestFocus();
}else if(ENABLE_SECOND.equals(e.getActionCommand())){
first.setEnabled(false);
second.setEnabled(true);
third.setEnabled(false);
fourth.setEnabled(false);
second.requestFocus();
}else if(ENABLE_THIRD.equals(e.getActionCommand())){
first.setEnabled(false);
second.setEnabled(false);
third.setEnabled(true);
fourth.setEnabled(false);
third.requestFocus();
}else if(ENABLE_FOURTH.equals(e.getActionCommand())){
first.setEnabled(false);
second.setEnabled(false);
third.setEnabled(false);
fourth.setEnabled(true);
fourth.requestFocus();
}
}
container.setSplitType(((JSplitRadioButton)e.getSource()).getSplitCommand());
}
}
pdfsam-1.1.4/pdfsam-launcher/ 0000755 0001750 0001750 00000000000 10633757456 016016 5 ustar twerner twerner pdfsam-1.1.4/pdfsam-launcher/Makefile.win 0000644 0001750 0001750 00000001776 11225355430 020245 0 ustar twerner twerner # Project: pdfsam
# Makefile created by Dev-C++ 4.9.9.2
CPP = g++.exe -D__DEBUG__
CC = gcc.exe -D__DEBUG__
WINDRES = windres.exe
RES = javastarter_private.res
OBJ = main.o $(RES)
LINKOBJ = main.o $(RES)
LIBS = -L"C:/Dev-Cpp/lib" -mwindows -s -g3
INCS = -I"C:/Dev-Cpp/include"
CXXINCS = -I"C:/Dev-Cpp/lib/gcc/mingw32/3.4.2/include" -I"C:/Dev-Cpp/include/c++/3.4.2/backward" -I"C:/Dev-Cpp/include/c++/3.4.2/mingw32" -I"C:/Dev-Cpp/include/c++/3.4.2" -I"C:/Dev-Cpp/include"
BIN = pdfsam-starter.exe
CXXFLAGS = $(CXXINCS) -g3
CFLAGS = $(INCS) -g3
RM = rm -f
.PHONY: all all-before all-after clean clean-custom
all: all-before pdfsam-starter.exe all-after
clean: clean-custom
${RM} $(OBJ) $(BIN)
$(BIN): $(OBJ)
$(CPP) $(LINKOBJ) -o "pdfsam-starter.exe" $(LIBS)
main.o: main.cpp
$(CPP) -c main.cpp -o main.o $(CXXFLAGS)
javastarter_private.res: javastarter_private.rc
$(WINDRES) -i javastarter_private.rc --input-format=rc -o javastarter_private.res -O coff
pdfsam-1.1.4/pdfsam-launcher/javastarter_private.res 0000644 0001750 0001750 00000043050 11225355434 022577 0 ustar twerner twerner L F .rsrc E < E @ UJ ( X UJ @ UJ UJ p UJ UJ UJ A (B C (C ( @ 7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7R7R7R7S7R7R7R7R7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7R7R7R7R7R7R7R7R7R7R7R7R777777777777777777777777777777777777777R7R7R7R7R7R7R7R7R7R7S7S7S7S7S77777777777777777777777777777777777777777777777777777777777R7R7S7S7S7S7777777777777777777777777{7{9s9T9T9Ty>y>y>y>y>y>y>y>y>y>eAfAbAaAaACECE::7777777777777777R7S7S7S7S7S777777777777777CECEdAi?k?y>y>y>y>y>y>y>y>y>y>y>y>y>y>y>y>fAfAdAeACECECE<777777777777777R7S7S7S7S7S77777777777777CEXBaAj?n?y>y>y>y>y>==========y>y>y>y>y>i@fAaACECECE97777777777777R7S7S7S7S7S7777777777777CE^AaAaAaAy>y>y>================y>y>y>y>h@dAaACECE7777777777777R7S7S7S7S7S777777777777:CEaAaAy>y>y>====<<<<<<<<<<======y>y>y>dAh@aACECE777777777777R7S7S7S7S7S777777777777CEaAbAy>y>y>==<<<<<<;;;;;;<<<<====y>y>y>y>fAbA^ACE77777777777R7S7S7S7S7777777777777CEaAcAy>y>y>==<<;;;;;:::;;;;<<<==y>y>y>y>y>g@dA^ACE7777777777R7R7S7S7S7777777777777CEbAf@i@y>y>===<;;;::::;;;;<=====y>y>y>i@g@^ACE7777777777S7S7S7S7777777777777CEaAf@m?y>y>y>==<<;;:::9988::;;;<<====y>y>y>y>eAfAFDCE777777777S7S7S7S7777777X8v7W77777CEaAdAdAy>y>===<<;;;;:::;;;;<<<===y>y>y>y>y>y>y>fAaACECE77777777S7S7S7S777777CEy>y>===<<<<;;;;;<<<<====y>y>y>y>i@bAaAaAbAaAaACE77777777S7S7S7S77777:CEZA9s777777CEaAaAg@y>y>y>=====<<<;<<<======y>y>y>eAdAdAaAaAaAaAaAaACECE7777777S7S7S7S77777:iCEaACE>777777CEaAaAfAy>y>y>y>=====<<=====y>y>y>y>y>g@dAi@KC77777777X9s9777777S7S7S7S7777:CEaAaAaA:o:777777CEaAfAg@fAy>y>y>y>y>=======y>y>y>y>y>h@fAdACE777777777777777777S7S7S7S7777;CEaAi@aAaA:o;777777CEaAaAcAfAg@y>y>y>y>====y>y>y>y>y>dAh@aACE77777777777777777777S7S7S7S7779CECEg@y>g@dAaA;i=777777CECEaAaAi@f@f@y>y>y>y>y>y>y>y>g@fAfAdACECE777777777777777777777S7S7S7S777:CEaAdAy>y>fAbAaA9s;7777777CEaAaAfAfAg@i?y>y>y>y>y>fAdAbACECE77777777777777777777777S7S7S7S77<9sCEdAy>y>y>y>i@aACE9s97777777CECECEaAaAaAdAf@e@e@e@aACECE7777777777777777777777777S7S7S7S77:CEbAfAy>y>y>y>y>dAdAaA9s9777777777CECECECECECECECECE777777777777CEaAaAaAaAaAaAaACE777777S7S7S7S77:lCGeAy>y>y>y>y>y>y>i@fAaA:o:9777777777777777777777777777CEaAaAaAaAaAaAaAaAaACE77777S7S7S7S77:l^AdAy>y>===y>y>y>dAj@bACEy>y>y>y>y>aAaACG7777S7S7S7S77:l^AfAy>y>====y>y>y>y>g@dAaAZACE77777777WWWW777777777CECECEaAaAy>y>y>y>y>y>y>y>aAaACE7X777S7S7S7S77:l^AdAy>y>=====y>y>y>y>i@aAaAZACE777777WWWWWW7777777CECEaAaAy>y>y>y>y>===y>y>y>aACE7777S7S7S7S77:laAdAy>y>=======y>y>y>g@eAaAaACE7777WWWWWWWW77777CECEaAaAy>y>y>y>y>=====y>y>aACE>777S7S7S7S77:laAdAy>y>==<<===y>y>y>y>g@fAaAaACE777WWWWWWWW7777CEaAaAaAy>y>y>y>y>======y>y>aACE>777S7S7S7S799saAdAy>y>==<<<====y>y>y>y>eAaAaACE77WWWWWWWW77aACEaAaAaAy>y>y>y>===<<<==y>y>aACE=777S7S7S7S799saAdAy>y>==:::<====y>y>y>l?i@aAaACE7WWWWWWWW7CECEaAaAaAy>y>y>====<<<<==y>y>aACE=777S7S7S7S7:y>==<:::<====y>y>y>m?e@aAaA77WWWWWW77CEaAaAaAy>y>y>====<<<<<==y>y>aACF=777S7S7S7S79y>==<::::<<====y>y>i@aAaAaACE7WWWW77CEaAaAaAy>y>y>===<<<::<<=y>y>y>aACE=777S7S7S7S779sUBdAy>y>==<<::::<<===y>y>y>e@aAaACE777777CEaAaAaAy>y>y>===<<<:::<<=y>y>aAaA9n>777S7S7S7S779CEaAh@y>y>==<::::::<<==y>y>y>fAaAaA777777CEaAaAy>y>y>===<<:::::<<=y>y>aAaA:g:777S7S7S7S777CEaAbAy>y>==<<::::::<<==y>y>i@aAaACE77777CEaAaAy>y>y>==<<<:::::<==y>y>aACE:l7777S7S7S7S777:l^AaAy>y>===<:::::<==y>y>y>h@aACE77777CEaAaAy>y>===<:::::<=y>y>aAaACE;7777S7S7S7S777;iCEbAy>y>y>==<::::::<===y>y>h@aACE77777CEaAaAy>y>==<<::::<==y>y>aAaACE<7777S7S7S7S7779CEaAi@y>y>y>==<:::::::<<=y>y>fAbACE77777CEaAaAy>y>==<<::::::<=y>y>y>aA^A:l77777S7S7S7S7777;gCEdAdAy>y>==<<::::::<<=y>y>fAbAZACE7777CEaAaAy>y>==<<::::<<==y>y>aAaACE9s77777S7S7S7S7777:CEbAfAy>y>y>==<<:::::<<=y>y>fAbA^ACE7777CEaAaAy>y>==<<:::<<==y>y>y>aAaA;f777777S7S7S7S777799CEi@eAy>y>===<<:::::<=y>y>fAbA^ACE7777CEaAaAy>y>==<<::<<===y>y>aAaACE9s777777S7S7S7S77777;CEdAdAy>y>y>===<:::::<=y>y>fAbA^ACE7777CEaAaAy>y>==<<:<<===y>y>aAaA^A>\9777777S7S7S7S777777:CEfAeAy>y>y>===<:::<<=y>y>fAbAaACE7777CEaAaAy>y>==<<<<===y>y>y>aAaACE:o7777777S7S7S7S7777777CEZAeAfAy>y>y>===<<<<<=y>y>fAbAaACE7777CEaAaAy>y>==<<<<==y>y>y>aAaA^A:l7777777R7S7S7S7S77777777CEWBaAi@y>y>y>===<<<==y>y>fAbAaACE7777CEaAaAy>y>==<<===y>y>y>aAaAaA:o=_7777777R7S7S7S7S777777777CEXBaAh@y>y>y>===<<==y>y>fAbAaACE7777CEaAaAy>y>======y>y>y>aAaAaACE:l77777777R7S7S7S7S7S777777779CE^AdAg@y>y>y>===<==y>y>i@bAaACE9777CEaAaAy>y>=====y>y>y>aAaACECE:o777777777R7S7S7S7S7S7777777779CEZAfAg@y>y>y>y>===y>y>y>h?aACE<7777CEaAaAy>y>===y>y>y>y>aAaAaACE;9777777777R7S7S7S7S7S77777777779CE^AbAfAfAy>y>y>y>y>y>y>fAcAaACE77777CEaAaAy>y>==y>y>y>y>aAaACECE:l77777777777R7S7S7S7S7S777777777777CEPCaAbAh@y>y>y>y>y>dAaAaACE:77777CEaAaAy>y>y>y>y>y>aAaAaACECE:777777777777R7S7S7S7S7S7777777777777CECFaA^AbAg@fAh@i@dAaAZACE977777CEaAaAy>y>y>aAaAaAaACECG;f97777777777777R7S7S7S7S7S777777777777777CECE^AaAbAaAaAaACECE7777777aAaAy>y>y>aAaAaA^ACECE9777777777777777R7S7S7S7S7S77777777777777777=ECECECECECE:7777777CEaAaAy>aAaAaACECE:l;i77777777777777777R7S7S7S7S7S77777777777777777778;97777777CECEaAaAaAaACECECECE<7777777777777777777R7S7S7S7S7S77777777777777777777777777777CECECECECECE789777777777777777777777R7S7S7S7S7S77777777777777777777777777777777777777777777777777777777777R7S7S7S7S7S77777777777777777777777777777777777777777777777777777777777R7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S77777777777777777777777777777777777S7S7S7S7S7S7S7S7S7S7S7S7R7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S @ @@ (B 4 V S _ V E R S I O N _ I N F O S t r i n g F i l e I n f o 0 8 0 9 0 4 E 4 " C o m p a n y N a m e , F i l e V e r s i o n 1 . 1 . 4 F F i l e D e s c r i p t i o n p d f s a m - s t a r t e r " I n t e r n a l N a m e & L e g a l C o p y r i g h t * L e g a l T r a d e m a r k s * O r i g i n a l F i l e n a m e H P r o d u c t N a m e P D F S p l i t A n d M e r g e 0 P r o d u c t V e r s i o n 1 . 1 . 4 D V a r F i l e I n f o $ T r a n s l a t i o n .rsrc pdfsam-1.1.4/pdfsam-launcher/main.cpp 0000644 0001750 0001750 00000052113 11225355424 017433 0 ustar twerner twerner /*
* Created on 09-Nov-2006
*
* Copyright notice: this code is based on GPL code of Xenoage Java Exe Starter 2.0
* (c) 2005 by Andreas Wenger, Xenoage Software.
* Copyright (C) 2006 by Andrea Vacondio.
*
* This program 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 2 of the License.
* This program 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 this program;
* if not, write to the Free Software Foundation, Inc.,
* 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#include
#include
#include
#define DEBUG_MODE
#define STR_LEN_1 100
#define STR_LEN_2 200
//char buffer
char buffer[5001] = "%XNG_JESTART_BUFFER% 321";
//buffer contents
//each entry must end with a '\0' character!
#define POS_JAR_NAME 0
#define LEN_JAR_NAME 100
#define POS_JAVA_EXE 100
#define LEN_JAVA_EXE 100
#define POS_JRE_REQUIRED 200
#define LEN_JRE_REQUIRED 100
#define POS_OPTIONS 400
#define LEN_OPTIONS 300
#define POS_ARGUMENTS 700
#define LEN_ARGUMENTS 300
#define POS_ERR_JRE_NOT_FOUND 2000
#define LEN_ERR_JRE_NOT_FOUND 300
#define POS_ERR_JRE_WRONG_VERSION 2300
#define LEN_ERR_JRE_WRONG_VERSION 300
#define POS_ERR_JRE_ERROR 2600
#define LEN_ERR_JRE_ERROR 300
#define POS_ERR_JAR_PACKED_ERROR 2900
#define LEN_ERR_JAR_PACKED_ERROR 300
#define POS_ERR_JAR_NOT_FOUND 3200
#define LEN_ERR_JAR_NOT_FOUND 300
#define POS_JAR_PACKED_NAME 4000
#define LEN_JAR_PACKED_NAME 100
//flags
#define POS_FLAGS 4900
#define FLAG_START_WITHOUT_REGISTRY 0
#define FLAG_START_DESPITE_REGISTRY_ERROR 1
#define FLAG_JRE_REQUIRED_OR_HIGHER 2
#define FLAG_JAR_PACKED 3
#define FLAG_JAR_DELETE_AT_END 4
//errors
#define ERR_REGISTRY_JRE_NOT_FOUND 100
#define ERR_REGISTRY_JRE_WRONG_VERSION 101
#define ERR_REGISTRY_JRE_ERROR 102
#define ERR_JAR_PACKED_ERROR 103
using namespace std;
void GetProgramDir(char* szProgramPath)
{
GetModuleFileName(NULL, (LPSTR)szProgramPath, MAX_PATH);
strcpy(strrchr((const char *)szProgramPath, '\\')+1, "");
//MessageBox(0, szProgramPath, 0, 0);
return;
}
void Replace(string& source, const string& find, const string& replace)
{
size_t j;
for (;(j = source.find(find)) != string::npos;)
{
source.replace(j, find.length(), replace);
}
}
inline void TrimR(string& source, const string& t = " ")
{
source.erase(source.find_last_not_of(t) + 1);
}
bool StartsWith(char s[], char find[])
{
bool thesame = true;
if (strlen(find) > strlen(s))
{
thesame = false;
}
else
{
int i = 0;
while ((find[i] != '\0') && thesame)
{
thesame = (find[i] == s[i]);
i++;
}
}
return thesame;
}
//Returns true, if the second version (v2) is
//higher than the first one (v1).
bool IsVersionHigher(char v1[], char v2[])
{
return (strcmp(v1, v2) < 0);
}
//Write into log file, if open
void Log(FILE *fLog, string text)
{
if (fLog != NULL)
{
text += "\n";
fprintf(fLog, text.c_str());
}
}
//Close log file, if open
void LogClose(FILE *fLog)
{
if (fLog != NULL)
{
fclose(fLog);
}
}
int main(int argc, char *argv[])
{
int err = 0;
char szProgramPath[MAX_PATH + 1];
GetProgramDir(szProgramPath);
//MessageBox(0, szProgramPath, 0, 0);
#ifdef DEBUG_MODE
//Test
strcpy(&buffer[POS_JAR_NAME], "pdfsam-1.1.4.jar");
strcpy(&buffer[POS_OPTIONS], "");
strcpy(&buffer[POS_ARGUMENTS], "xmx");
strcpy(&buffer[POS_JAVA_EXE], "javaw.exe");
strcpy(&buffer[POS_JRE_REQUIRED], "1.4.2");
strcpy(&buffer[POS_ERR_JRE_NOT_FOUND], "No JRE found on your system! please download and install a working Java Virtual Machine.");
strcpy(&buffer[POS_ERR_JRE_WRONG_VERSION], "Sorry, no suitable JRE version found on your system!");
strcpy(&buffer[POS_ERR_JRE_ERROR], "Something is wrong with your JRE configuration! Reinstall Java!");
strcpy(&buffer[POS_ERR_JAR_PACKED_ERROR], "Temporary Jar could not be extracted! Exe file is corrupt!");
strcpy(&buffer[POS_JAR_PACKED_NAME], "myjar.tmp");
buffer[POS_FLAGS + FLAG_JRE_REQUIRED_OR_HIGHER] = '1';
buffer[POS_FLAGS + FLAG_START_DESPITE_REGISTRY_ERROR] = '1';
buffer[POS_FLAGS + FLAG_START_WITHOUT_REGISTRY] = '0';
buffer[POS_FLAGS + FLAG_JAR_PACKED] = '0';
buffer[POS_FLAGS + FLAG_JAR_DELETE_AT_END] = '1';
#endif
//if file jestartlog.txt exists, use it for logging the start process
//(will be overwritten)
bool bLog = false;
FILE *fLog = fopen("pdfsam-launcher-log.txt", "r");
if (fLog != NULL)
{
fclose(fLog);
fLog = fopen("pdfsam-launcher-log.txt", "w");
Log(fLog, "Logging started.");
if (fLog != NULL) bLog = true;
}
char current_jre[STR_LEN_1] = ""; DWORD current_jre_size = STR_LEN_1;
char use_jre[STR_LEN_1] = ""; DWORD use_jre_size = STR_LEN_1;
char use_jre_path[STR_LEN_2] = ""; DWORD use_jre_path_size = STR_LEN_2;
//Just start the default Java executable or search in the registry?
if (buffer[POS_FLAGS + FLAG_START_WITHOUT_REGISTRY] != '1')
{
//Search in registry for installed JREs and find a suitable one
Log(fLog, "Search for JRE in Registry...");
HKEY regkey = 0;
if (RegOpenKeyEx(HKEY_LOCAL_MACHINE, "Software\\JavaSoft\\Java Runtime Environment\\",
0, KEY_READ, ®key) == ERROR_SUCCESS)
{
//Read current JRE version
if (RegQueryValueEx(regkey, "CurrentVersion", 0, 0,
(BYTE*) current_jre, ¤t_jre_size) != ERROR_SUCCESS)
{
Log(fLog, "Could not read current version!");
}
else
{
Log(fLog, (string) "Current JRE version: " + (string) current_jre);
}
int i = 0, ret;
char vers[STR_LEN_1]; DWORD vers_size = STR_LEN_1;
do
{
vers_size = STR_LEN_1;
ret = RegEnumKeyEx(regkey, i, vers, &vers_size, 0, 0, 0, 0);
if (ret == ERROR_SUCCESS)
{
Log(fLog, (string) "JRE found: " + (string) vers);
//Is this a allowed version? It is allowed, if it starts with
//the "required jre string" or if the higher-flag is set and
//vers is a newer version than the required jre.
bool allowed = false;
if (StartsWith(vers, &buffer[POS_JRE_REQUIRED]) ||
((buffer[POS_FLAGS + FLAG_JRE_REQUIRED_OR_HIGHER] == '1') &&
IsVersionHigher(&buffer[POS_JRE_REQUIRED], vers)))
{
//We can use it! (Overwrite old setting, if this
//version is newer than the last one)
if ((strlen(use_jre) == 0) || IsVersionHigher(use_jre, vers))
{
strcpy(use_jre, vers);
//Read the path of the JRE
HKEY pathkey;
if (RegOpenKeyEx(regkey, use_jre,
0, KEY_READ, &pathkey) == ERROR_SUCCESS)
{
use_jre_path_size = STR_LEN_2;
if (RegQueryValueEx(pathkey, "JavaHome", 0, 0,
(BYTE*) use_jre_path, &use_jre_path_size) != ERROR_SUCCESS)
{
//Error!
//MessageBox(0, err_jreerror, 0, MB_ICONERROR);
//return 0;
err = ERR_REGISTRY_JRE_ERROR;
ret = ERROR_SUCCESS - 1; //break the loop
}
RegCloseKey(pathkey);
}
else
{
//Error!
//MessageBox(0, err_jreerror, 0, MB_ICONERROR);
//return 0;
err = ERR_REGISTRY_JRE_ERROR;
ret = ERROR_SUCCESS - 1; //break the loop
}
}
//Is this also the "current version" on this system? If
//yes, use it and do not overwrite this setting any more.
if (strcmp(use_jre, current_jre) == 0)
{
ret = ERROR_SUCCESS - 1; //break the loop
}
}
}
i++;
} while (ret == ERROR_SUCCESS);
RegCloseKey(regkey);
//if use_jre is empty, we found no suitable JRE
if (strlen(use_jre) == 0)
{
err = ERR_REGISTRY_JRE_WRONG_VERSION;
}
}
else
{
//Error!
//MessageBox(0, err_nojrefound, 0, MB_ICONERROR);
//return 0;
err = ERR_REGISTRY_JRE_NOT_FOUND;
}
}
//See if we found a JRE
if ((err == 0) && (strlen(use_jre) > 0))
{
//We found one
Log(fLog, (string) "JRE selected: " + (string) use_jre);
Log(fLog, (string) "JRE path selected: " + (string) use_jre_path);
//MessageBox(0, use_jre, 0, MB_ICONINFORMATION);
//MessageBox(0, use_jre_path, 0, MB_ICONINFORMATION);
}
else if (err != 0)
{
//An error occured!
//Show an error message and exit or proceed without a message and try
//to start anyway if FLAG_START_DESPITE_REGISTRY_ERROR is set
if ((buffer[POS_FLAGS + FLAG_START_DESPITE_REGISTRY_ERROR] == '1') &&
(err != ERR_REGISTRY_JRE_WRONG_VERSION))
{
Log(fLog, "Error: Registry error, but trying to start anyway...");
strcpy(use_jre_path, "");
}
else
{
if (err == ERR_REGISTRY_JRE_NOT_FOUND)
{
//No JRE could be found in the registry
Log(fLog, (string) "Error: " + (string) &buffer[POS_ERR_JRE_NOT_FOUND]);
MessageBox(0, &buffer[POS_ERR_JRE_NOT_FOUND], 0, MB_ICONERROR);
}
else if (err == ERR_REGISTRY_JRE_WRONG_VERSION)
{
//No suitable JRE could be found in the registry
Log(fLog, (string) "Error: " + (string) &buffer[POS_ERR_JRE_WRONG_VERSION]);
MessageBox(0, &buffer[POS_ERR_JRE_WRONG_VERSION], 0, MB_ICONERROR);
}
else if (err == ERR_REGISTRY_JRE_ERROR)
{
//Something is wrong with the JRE configuration in the registry
Log(fLog, (string) "Error: " + (string) &buffer[POS_ERR_JRE_ERROR]);
MessageBox(0, &buffer[POS_ERR_JRE_ERROR], 0, MB_ICONERROR);
}
LogClose(fLog);
return 0;
}
}
//java executable path
string javaexe = &buffer[POS_JAVA_EXE];
if (strlen(use_jre_path) > 0)
{
javaexe.insert(0, string(use_jre_path) + string("\\bin\\"));
}
Log(fLog, (string) "Java executable path: " + javaexe);
//if jar is packed in the exe, extract it now
bool jarpacked = (buffer[POS_FLAGS + FLAG_JAR_PACKED] == '1');
if (jarpacked)
{
int err = ERR_JAR_PACKED_ERROR; //change this only if everything worked fine
//open this exe file and search for the start sign
//"%XNG_JESTART_JAR_PACKED%"
FILE *fexe;
char exepath[MAX_PATH + 1];
GetModuleFileName(NULL, (LPSTR)exepath, MAX_PATH);
fexe = fopen(exepath, "rb");
if (fexe != NULL)
{
//get file size
fseek (fexe, 0, SEEK_END);
long fexelen = ftell(fexe);
rewind (fexe);
//char ttt[100];
//sprintf(ttt, "%i", fexelen);
//MessageBox(0, ttt, 0, 0);
// allocate memory to contain the whole file
char *fexebuffer = (char*) malloc (fexelen);
if (fexebuffer != NULL)
{
//copy the file into the buffer
fread(fexebuffer, 1, fexelen, fexe);
//search for the start sign
int i = 0;
char startsign[25] = "_XNG_JESTART_JAR_PACKED_";
startsign[0] = '%';
startsign[23] = '%';
int startsignlen = strlen(startsign);
int startsignpos = -1;
while ((i < fexelen - startsignlen) && (startsignpos == -1))
{
if (fexebuffer[i] == '%')
{
if (strncmp(&fexebuffer[i], startsign, startsignlen) == 0)
{
startsignpos = i;
}
}
i++;
} /*
char ttt[100];
sprintf(ttt, "%i", i);
MessageBox(0, ttt, 0, 0); */
if (startsignpos > -1)
{
startsignpos = startsignpos + startsignlen;
//create temp jar file
char ftemppath[MAX_PATH + 1];
GetProgramDir(ftemppath);
strcat(ftemppath, &buffer[POS_JAR_PACKED_NAME]);
FILE *ftemp = fopen(ftemppath, "wb");
if (ftemp != NULL)
{
fwrite(&fexebuffer[startsignpos], 1, fexelen - startsignpos, ftemp);
//char ttt[100];
//sprintf(ttt, "%i", fexelen - startsignpos);
//MessageBox(0, ttt, 0, 0);
//everything went ok
err = 0;
//terminate ftemp
fclose(ftemp);
}
Log(fLog, (string) "Temp Jar extracted to: " + (string) ftemppath);
}
//terminate fexe
fclose(fexe);
free(fexebuffer);
}
}
if (err != 0)
{
//An error occured!
Log(fLog, (string) "Error: " + (string) &buffer[POS_ERR_JAR_PACKED_ERROR]);
MessageBox(0, &buffer[POS_ERR_JAR_PACKED_ERROR], 0, MB_ICONERROR);
LogClose(fLog);
return 0;
}
}
//filename of jar
string jarname;
if (jarpacked)
{
jarname = &buffer[POS_JAR_PACKED_NAME];
}
else
{
jarname = &buffer[POS_JAR_NAME];
}
Log(fLog, (string) "JAR path: " + jarname);
//look if jar exists, if not, show error
FILE *fJar = fopen(jarname.c_str(), "r");
if (fJar != NULL)
{
fclose(fJar);
}
else
{
//let the user change this message in later versions
string s_jarnotfound = "Jar not found:\n" + jarname;
MessageBox(0, s_jarnotfound.c_str(), 0, MB_ICONERROR);
return 0;
}
//options
string options_f1 = "%path%";
string ProgPathWithoutEndBackSlash = szProgramPath;
ProgPathWithoutEndBackSlash = ProgPathWithoutEndBackSlash.substr(0,
ProgPathWithoutEndBackSlash.length() - 1);
string options_r1 = string("\"") + ProgPathWithoutEndBackSlash + string("\"");
string options = &buffer[POS_OPTIONS];
Replace(options, options_f1, options_r1);
Log(fLog, (string) "Options : " + options);
//arguments
string arguments_f1 = "xmx";
string arguments_r1 = "";
for (int i = 1; i < argc; i++)
{
arguments_r1 += string("\"") + argv[i] + string("\" ");
}
//MessageBox(0, arguments_r1.c_str(), 0, 0);
string arguments = &buffer[POS_ARGUMENTS];
Replace(arguments, arguments_f1, arguments_r1);
if(arguments.length() == 0){
arguments = "-Xmx256m";
}
Log(fLog, (string) "Arguments : " + arguments);
string javaargs =
//Options...
options +" "+ arguments +string(" -jar ") +
//JAR-name with complete path
string("\"") + szProgramPath + jarname + string("\" ")
//Arguments
;
Log(fLog, (string) "Java arguments : " + javaargs);
//MessageBox(0, javaexe.c_str(), 0, 0);
//MessageBox(0, javaargs.c_str(), 0, 0);
//ShellExecute(NULL, NULL, javaexe.c_str(), javaargs.c_str(), NULL, SW_HIDE);
//ShellExecute(NULL, NULL, "javaw", "-classpath \"D:\\C++\\Projekte\\test2\\\" -jar notepad.jar", NULL, SW_HIDE);
Log(fLog, "Generating ShellExecute information...");
SHELLEXECUTEINFO SE;
memset(&SE,0,sizeof(SE));
SE.fMask = SEE_MASK_NOCLOSEPROCESS ;
SE.lpFile = javaexe.c_str();
SE.lpParameters = javaargs.c_str();
SE.nShow = SW_SHOW;
SE.cbSize = sizeof(SE);
Log(fLog, "Starting...");
ShellExecuteEx(&SE);
//Delete temporary file at the end, if desired
if (jarpacked && (buffer[POS_FLAGS + FLAG_JAR_DELETE_AT_END] == '1'))
{
//MessageBox(0, "Running", 0, 0);
if (SE.hProcess)
{
WaitForSingleObject(SE.hProcess, INFINITE);
CloseHandle(SE.hProcess);
}
Log(fLog, "Closed. Trying to delete temp Jar file...");
char ftemppath[MAX_PATH + 1];
GetProgramDir(ftemppath);
strcat(ftemppath, &buffer[POS_JAR_PACKED_NAME]);
remove(ftemppath);
Log(fLog, "Deleted.");
}
else
{
Log(fLog, "Starter closed.");
}
//getchar ();
LogClose(fLog);
return 0;
}
pdfsam-1.1.4/pdfsam-launcher/javastarter_private.h 0000644 0001750 0001750 00000001132 11225355416 022230 0 ustar twerner twerner /* THIS FILE WILL BE OVERWRITTEN BY DEV-C++ */
/* DO NOT EDIT ! */
#ifndef JAVASTARTER_PRIVATE_H
#define JAVASTARTER_PRIVATE_H
/* VERSION DEFINITIONS */
#define VER_STRING "1.1.4.0"
#define VER_MAJOR 1
#define VER_MINOR 1
#define VER_RELEASE 4
#define VER_BUILD 0
#define COMPANY_NAME ""
#define FILE_VERSION "1.1.4"
#define FILE_DESCRIPTION "pdfsam-starter"
#define INTERNAL_NAME ""
#define LEGAL_COPYRIGHT ""
#define LEGAL_TRADEMARKS ""
#define ORIGINAL_FILENAME ""
#define PRODUCT_NAME "PDF Split And Merge"
#define PRODUCT_VERSION "1.1.4"
#endif /*JAVASTARTER_PRIVATE_H*/
pdfsam-1.1.4/pdfsam-launcher/javastarter_private.rc 0000644 0001750 0001750 00000001460 11225355416 022411 0 ustar twerner twerner /* THIS FILE WILL BE OVERWRITTEN BY DEV-C++ */
/* DO NOT EDIT! */
#include // include for version info constants
A ICON MOVEABLE PURE LOADONCALL DISCARDABLE "javastarter.ico"
//
// TO CHANGE VERSION INFORMATION, EDIT PROJECT OPTIONS...
//
1 VERSIONINFO
FILEVERSION 1,1,4,0
PRODUCTVERSION 1,1,4,0
FILETYPE VFT_APP
{
BLOCK "StringFileInfo"
{
BLOCK "080904E4"
{
VALUE "CompanyName", ""
VALUE "FileVersion", "1.1.4"
VALUE "FileDescription", "pdfsam-starter"
VALUE "InternalName", ""
VALUE "LegalCopyright", ""
VALUE "LegalTrademarks", ""
VALUE "OriginalFilename", ""
VALUE "ProductName", "PDF Split And Merge"
VALUE "ProductVersion", "1.1.4"
}
}
BLOCK "VarFileInfo"
{
VALUE "Translation", 0x0809, 1252
}
}
pdfsam-1.1.4/pdfsam-launcher/javastarter.layout 0000644 0001750 0001750 00000000255 11225355460 021570 0 ustar twerner twerner [Editor_1]
CursorCol=1
CursorRow=1
TopLine=1
LeftChar=1
[Editors]
Focused=0
Order=0
[Editor_0]
Open=1
Top=1
CursorCol=48
CursorRow=166
TopLine=149
LeftChar=1
pdfsam-1.1.4/pdfsam-launcher/pdf-enhanced.ico 0000644 0001750 0001750 00000013076 10573256626 021031 0 ustar twerner twerner @@ ( ( @ D^ KH e Z D ; DT `~ K} ur G D uח Jk c` k IF Dk W} T Q D } ޢ Y ir Dq UY \k iɍ D ~Ь X q T c ٷ Pr Px xô K\ Mx IG Sg FP q{ }{ kh \ Ig S Zu R b G D M Eq T \ ZW |؞ D Gj b ]` EW D Dz aj TQ W P Qr Gv ѷ Df Je ئ W g IF T ge qn X Tx L rv Iu \f W W R N Ӻ s KH T Dk M i ^[ [p X Lm D } OL D D Gx WT Hj Y D J{ ݵ T D Dn P D bc Z Ei Fa Ka Sk L ڢ Ge DU D O{ м Dv D ۤ Kj v `] Ej N IG IG b Nq Is D D Dh Dn g D} D G F D D D Kv Iu [s MJ T L N F` Db GO Il P X yų HF Km J[ Fj T J` rp N kj D D D D D T} ߴ K| պ T M M O T Z g IF Ds Dx \ D P D D D D D D D D Zs D Gx E_ F_ UR VS FW YV ^_ Jb Rh Zr \r K~ NNNNNNNN _33333333333333333333333 33333333333333rZZZZZZZZZZZZr333333333333 E 3}RRRRRR.tttttttttW.RRRRRR}3 3}RRRHww&ttt&wwHRRR}3 3RRRHwwwwwD$$$$$$$$ꊮlwwwwHRRR3 N3RRHwwwww>D$$$$殭D>wwwwHRR3 N3RHwwwwwF $OO$D>wwwwHR3N N3Rwwwww
TOԬO D>wwwwR3N 53RwwwwaP홀ԬӬ>wwwR3N 3Rwwwa8Հ{ss?ӬOD>wwR3N 3Rwwa88$O{{{{wR3 3Hww888Aotӵ̾ӬO$DH3 3xwH3N 53HwxOYd|| Y괙O걭wwR3N N3RwwOYi
6Y괙O걭wwR3N N3Rwww$OY88 Y괙O$걭wwwR3N N3Rwwww $$ 888 Y괙O걭wwwwR3 N3RwwwwQY$wwwwHR3 3RRwwwwxu"wwwwkY殮DlwwwwHRR3 3RRRwwwwx&DwwwwkꊭwwwwwHRRR3 3}RRRHwxyyMwwwwYtyyxwHRRR}3 3}RRRRRRR4UUUUU!YWRRRRRRR}3 ZZZ0 3333333333333r0r3333333333333 _3333333333333333333333_ 5 NNNNNNNN pdfsam-1.1.4/pdfsam-launcher/javastarter.ico 0000644 0001750 0001750 00000041076 10636000720 021022 0 ustar twerner twerner @@ (B ( @ 7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7R7R7R7S7R7R7R7R7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7R7R7R7R7R7R7R7R7R7R7R7R777777777777777777777777777777777777777R7R7R7R7R7R7R7R7R7R7S7S7S7S7S77777777777777777777777777777777777777777777777777777777777R7R7S7S7S7S7777777777777777777777777{7{9s9T9T9Ty>y>y>y>y>y>y>y>y>y>eAfAbAaAaACECE::7777777777777777R7S7S7S7S7S777777777777777CECEdAi?k?y>y>y>y>y>y>y>y>y>y>y>y>y>y>y>y>fAfAdAeACECECE<777777777777777R7S7S7S7S7S77777777777777CEXBaAj?n?y>y>y>y>y>==========y>y>y>y>y>i@fAaACECECE97777777777777R7S7S7S7S7S7777777777777CE^AaAaAaAy>y>y>================y>y>y>y>h@dAaACECE7777777777777R7S7S7S7S7S777777777777:CEaAaAy>y>y>====<<<<<<<<<<======y>y>y>dAh@aACECE777777777777R7S7S7S7S7S777777777777CEaAbAy>y>y>==<<<<<<;;;;;;<<<<====y>y>y>y>fAbA^ACE77777777777R7S7S7S7S7777777777777CEaAcAy>y>y>==<<;;;;;:::;;;;<<<==y>y>y>y>y>g@dA^ACE7777777777R7R7S7S7S7777777777777CEbAf@i@y>y>===<;;;::::;;;;<=====y>y>y>i@g@^ACE7777777777S7S7S7S7777777777777CEaAf@m?y>y>y>==<<;;:::9988::;;;<<====y>y>y>y>eAfAFDCE777777777S7S7S7S7777777X8v7W77777CEaAdAdAy>y>===<<;;;;:::;;;;<<<===y>y>y>y>y>y>y>fAaACECE77777777S7S7S7S777777CEy>y>===<<<<;;;;;<<<<====y>y>y>y>i@bAaAaAbAaAaACE77777777S7S7S7S77777:CEZA9s777777CEaAaAg@y>y>y>=====<<<;<<<======y>y>y>eAdAdAaAaAaAaAaAaACECE7777777S7S7S7S77777:iCEaACE>777777CEaAaAfAy>y>y>y>=====<<=====y>y>y>y>y>g@dAi@KC77777777X9s9777777S7S7S7S7777:CEaAaAaA:o:777777CEaAfAg@fAy>y>y>y>y>=======y>y>y>y>y>h@fAdACE777777777777777777S7S7S7S7777;CEaAi@aAaA:o;777777CEaAaAcAfAg@y>y>y>y>====y>y>y>y>y>dAh@aACE77777777777777777777S7S7S7S7779CECEg@y>g@dAaA;i=777777CECEaAaAi@f@f@y>y>y>y>y>y>y>y>g@fAfAdACECE777777777777777777777S7S7S7S777:CEaAdAy>y>fAbAaA9s;7777777CEaAaAfAfAg@i?y>y>y>y>y>fAdAbACECE77777777777777777777777S7S7S7S77<9sCEdAy>y>y>y>i@aACE9s97777777CECECEaAaAaAdAf@e@e@e@aACECE7777777777777777777777777S7S7S7S77:CEbAfAy>y>y>y>y>dAdAaA9s9777777777CECECECECECECECECE777777777777CEaAaAaAaAaAaAaACE777777S7S7S7S77:lCGeAy>y>y>y>y>y>y>i@fAaA:o:9777777777777777777777777777CEaAaAaAaAaAaAaAaAaACE77777S7S7S7S77:l^AdAy>y>===y>y>y>dAj@bACEy>y>y>y>y>aAaACG7777S7S7S7S77:l^AfAy>y>====y>y>y>y>g@dAaAZACE77777777WWWW777777777CECECEaAaAy>y>y>y>y>y>y>y>aAaACE7X777S7S7S7S77:l^AdAy>y>=====y>y>y>y>i@aAaAZACE777777WWWWWW7777777CECEaAaAy>y>y>y>y>===y>y>y>aACE7777S7S7S7S77:laAdAy>y>=======y>y>y>g@eAaAaACE7777WWWWWWWW77777CECEaAaAy>y>y>y>y>=====y>y>aACE>777S7S7S7S77:laAdAy>y>==<<===y>y>y>y>g@fAaAaACE777WWWWWWWW7777CEaAaAaAy>y>y>y>y>======y>y>aACE>777S7S7S7S799saAdAy>y>==<<<====y>y>y>y>eAaAaACE77WWWWWWWW77aACEaAaAaAy>y>y>y>===<<<==y>y>aACE=777S7S7S7S799saAdAy>y>==:::<====y>y>y>l?i@aAaACE7WWWWWWWW7CECEaAaAaAy>y>y>====<<<<==y>y>aACE=777S7S7S7S7:y>==<:::<====y>y>y>m?e@aAaA77WWWWWW77CEaAaAaAy>y>y>====<<<<<==y>y>aACF=777S7S7S7S79y>==<::::<<====y>y>i@aAaAaACE7WWWW77CEaAaAaAy>y>y>===<<<::<<=y>y>y>aACE=777S7S7S7S779sUBdAy>y>==<<::::<<===y>y>y>e@aAaACE777777CEaAaAaAy>y>y>===<<<:::<<=y>y>aAaA9n>777S7S7S7S779CEaAh@y>y>==<::::::<<==y>y>y>fAaAaA777777CEaAaAy>y>y>===<<:::::<<=y>y>aAaA:g:777S7S7S7S777CEaAbAy>y>==<<::::::<<==y>y>i@aAaACE77777CEaAaAy>y>y>==<<<:::::<==y>y>aACE:l7777S7S7S7S777:l^AaAy>y>===<:::::<==y>y>y>h@aACE77777CEaAaAy>y>===<:::::<=y>y>aAaACE;7777S7S7S7S777;iCEbAy>y>y>==<::::::<===y>y>h@aACE77777CEaAaAy>y>==<<::::<==y>y>aAaACE<7777S7S7S7S7779CEaAi@y>y>y>==<:::::::<<=y>y>fAbACE77777CEaAaAy>y>==<<::::::<=y>y>y>aA^A:l77777S7S7S7S7777;gCEdAdAy>y>==<<::::::<<=y>y>fAbAZACE7777CEaAaAy>y>==<<::::<<==y>y>aAaACE9s77777S7S7S7S7777:CEbAfAy>y>y>==<<:::::<<=y>y>fAbA^ACE7777CEaAaAy>y>==<<:::<<==y>y>y>aAaA;f777777S7S7S7S777799CEi@eAy>y>===<<:::::<=y>y>fAbA^ACE7777CEaAaAy>y>==<<::<<===y>y>aAaACE9s777777S7S7S7S77777;CEdAdAy>y>y>===<:::::<=y>y>fAbA^ACE7777CEaAaAy>y>==<<:<<===y>y>aAaA^A>\9777777S7S7S7S777777:CEfAeAy>y>y>===<:::<<=y>y>fAbAaACE7777CEaAaAy>y>==<<<<===y>y>y>aAaACE:o7777777S7S7S7S7777777CEZAeAfAy>y>y>===<<<<<=y>y>fAbAaACE7777CEaAaAy>y>==<<<<==y>y>y>aAaA^A:l7777777R7S7S7S7S77777777CEWBaAi@y>y>y>===<<<==y>y>fAbAaACE7777CEaAaAy>y>==<<===y>y>y>aAaAaA:o=_7777777R7S7S7S7S777777777CEXBaAh@y>y>y>===<<==y>y>fAbAaACE7777CEaAaAy>y>======y>y>y>aAaAaACE:l77777777R7S7S7S7S7S777777779CE^AdAg@y>y>y>===<==y>y>i@bAaACE9777CEaAaAy>y>=====y>y>y>aAaACECE:o777777777R7S7S7S7S7S7777777779CEZAfAg@y>y>y>y>===y>y>y>h?aACE<7777CEaAaAy>y>===y>y>y>y>aAaAaACE;9777777777R7S7S7S7S7S77777777779CE^AbAfAfAy>y>y>y>y>y>y>fAcAaACE77777CEaAaAy>y>==y>y>y>y>aAaACECE:l77777777777R7S7S7S7S7S777777777777CEPCaAbAh@y>y>y>y>y>dAaAaACE:77777CEaAaAy>y>y>y>y>y>aAaAaACECE:777777777777R7S7S7S7S7S7777777777777CECFaA^AbAg@fAh@i@dAaAZACE977777CEaAaAy>y>y>aAaAaAaACECG;f97777777777777R7S7S7S7S7S777777777777777CECE^AaAbAaAaAaACECE7777777aAaAy>y>y>aAaAaA^ACECE9777777777777777R7S7S7S7S7S77777777777777777=ECECECECECE:7777777CEaAaAy>aAaAaACECE:l;i77777777777777777R7S7S7S7S7S77777777777777777778;97777777CECEaAaAaAaACECECECE<7777777777777777777R7S7S7S7S7S77777777777777777777777777777CECECECECECE789777777777777777777777R7S7S7S7S7S77777777777777777777777777777777777777777777777777777777777R7S7S7S7S7S77777777777777777777777777777777777777777777777777777777777R7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S77777777777777777777777777777777777S7S7S7S7S7S7S7S7S7S7S7S7R7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S @ pdfsam-1.1.4/pdfsam-launcher/javastarter.dev 0000644 0001750 0001750 00000001730 11225355430 021025 0 ustar twerner twerner [Project]
FileName=javastarter.dev
Name=pdfsam
UnitCount=1
Type=0
Ver=1
ObjFiles=
Includes=
Libs=
PrivateResource=javastarter_private.rc
ResourceIncludes=
MakeIncludes=
Compiler=_@@_
CppCompiler=_@@_
Linker=-s_@@_
IsCpp=1
Icon=javastarter.ico
ExeOutput=
ObjectOutput=
OverrideOutput=1
OverrideOutputName=pdfsam-starter.exe
HostApplication=
Folders=
CommandLine=-Xmx512m
UseCustomMakefile=0
CustomMakefile=
IncludeVersionInfo=1
SupportXPThemes=0
CompilerSet=0
CompilerSettings=0000000000000001000000
[Unit1]
FileName=main.cpp
CompileCpp=1
Folder=main.cpp
Compile=1
Link=1
Priority=1000
OverrideBuildCmd=0
BuildCmd=
[VersionInfo]
Major=1
Minor=1
Release=4
Build=0
LanguageID=2057
CharsetID=1252
CompanyName=
FileVersion=1.1.4
FileDescription=pdfsam-starter
InternalName=
LegalCopyright=
LegalTrademarks=
OriginalFilename=
ProductName=PDF Split And Merge
ProductVersion=1.1.4
AutoIncBuildNr=0
[Unit3]
FileName=buffer.cpp
pdfsam-1.1.4/pdfsam-launcher/pdf-basic.ico 0000644 0001750 0001750 00000041076 10636000720 020324 0 ustar twerner twerner @@ (B ( @ 7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7R7R7R7S7R7R7R7R7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7R7R7R7R7R7R7R7R7R7R7R7R777777777777777777777777777777777777777R7R7R7R7R7R7R7R7R7R7S7S7S7S7S77777777777777777777777777777777777777777777777777777777777R7R7S7S7S7S7777777777777777777777777{7{9s9T9T9Ty>y>y>y>y>y>y>y>y>y>eAfAbAaAaACECE::7777777777777777R7S7S7S7S7S777777777777777CECEdAi?k?y>y>y>y>y>y>y>y>y>y>y>y>y>y>y>y>fAfAdAeACECECE<777777777777777R7S7S7S7S7S77777777777777CEXBaAj?n?y>y>y>y>y>==========y>y>y>y>y>i@fAaACECECE97777777777777R7S7S7S7S7S7777777777777CE^AaAaAaAy>y>y>================y>y>y>y>h@dAaACECE7777777777777R7S7S7S7S7S777777777777:CEaAaAy>y>y>====<<<<<<<<<<======y>y>y>dAh@aACECE777777777777R7S7S7S7S7S777777777777CEaAbAy>y>y>==<<<<<<;;;;;;<<<<====y>y>y>y>fAbA^ACE77777777777R7S7S7S7S7777777777777CEaAcAy>y>y>==<<;;;;;:::;;;;<<<==y>y>y>y>y>g@dA^ACE7777777777R7R7S7S7S7777777777777CEbAf@i@y>y>===<;;;::::;;;;<=====y>y>y>i@g@^ACE7777777777S7S7S7S7777777777777CEaAf@m?y>y>y>==<<;;:::9988::;;;<<====y>y>y>y>eAfAFDCE777777777S7S7S7S7777777X8v7W77777CEaAdAdAy>y>===<<;;;;:::;;;;<<<===y>y>y>y>y>y>y>fAaACECE77777777S7S7S7S777777CEy>y>===<<<<;;;;;<<<<====y>y>y>y>i@bAaAaAbAaAaACE77777777S7S7S7S77777:CEZA9s777777CEaAaAg@y>y>y>=====<<<;<<<======y>y>y>eAdAdAaAaAaAaAaAaACECE7777777S7S7S7S77777:iCEaACE>777777CEaAaAfAy>y>y>y>=====<<=====y>y>y>y>y>g@dAi@KC77777777X9s9777777S7S7S7S7777:CEaAaAaA:o:777777CEaAfAg@fAy>y>y>y>y>=======y>y>y>y>y>h@fAdACE777777777777777777S7S7S7S7777;CEaAi@aAaA:o;777777CEaAaAcAfAg@y>y>y>y>====y>y>y>y>y>dAh@aACE77777777777777777777S7S7S7S7779CECEg@y>g@dAaA;i=777777CECEaAaAi@f@f@y>y>y>y>y>y>y>y>g@fAfAdACECE777777777777777777777S7S7S7S777:CEaAdAy>y>fAbAaA9s;7777777CEaAaAfAfAg@i?y>y>y>y>y>fAdAbACECE77777777777777777777777S7S7S7S77<9sCEdAy>y>y>y>i@aACE9s97777777CECECEaAaAaAdAf@e@e@e@aACECE7777777777777777777777777S7S7S7S77:CEbAfAy>y>y>y>y>dAdAaA9s9777777777CECECECECECECECECE777777777777CEaAaAaAaAaAaAaACE777777S7S7S7S77:lCGeAy>y>y>y>y>y>y>i@fAaA:o:9777777777777777777777777777CEaAaAaAaAaAaAaAaAaACE77777S7S7S7S77:l^AdAy>y>===y>y>y>dAj@bACEy>y>y>y>y>aAaACG7777S7S7S7S77:l^AfAy>y>====y>y>y>y>g@dAaAZACE77777777WWWW777777777CECECEaAaAy>y>y>y>y>y>y>y>aAaACE7X777S7S7S7S77:l^AdAy>y>=====y>y>y>y>i@aAaAZACE777777WWWWWW7777777CECEaAaAy>y>y>y>y>===y>y>y>aACE7777S7S7S7S77:laAdAy>y>=======y>y>y>g@eAaAaACE7777WWWWWWWW77777CECEaAaAy>y>y>y>y>=====y>y>aACE>777S7S7S7S77:laAdAy>y>==<<===y>y>y>y>g@fAaAaACE777WWWWWWWW7777CEaAaAaAy>y>y>y>y>======y>y>aACE>777S7S7S7S799saAdAy>y>==<<<====y>y>y>y>eAaAaACE77WWWWWWWW77aACEaAaAaAy>y>y>y>===<<<==y>y>aACE=777S7S7S7S799saAdAy>y>==:::<====y>y>y>l?i@aAaACE7WWWWWWWW7CECEaAaAaAy>y>y>====<<<<==y>y>aACE=777S7S7S7S7:y>==<:::<====y>y>y>m?e@aAaA77WWWWWW77CEaAaAaAy>y>y>====<<<<<==y>y>aACF=777S7S7S7S79y>==<::::<<====y>y>i@aAaAaACE7WWWW77CEaAaAaAy>y>y>===<<<::<<=y>y>y>aACE=777S7S7S7S779sUBdAy>y>==<<::::<<===y>y>y>e@aAaACE777777CEaAaAaAy>y>y>===<<<:::<<=y>y>aAaA9n>777S7S7S7S779CEaAh@y>y>==<::::::<<==y>y>y>fAaAaA777777CEaAaAy>y>y>===<<:::::<<=y>y>aAaA:g:777S7S7S7S777CEaAbAy>y>==<<::::::<<==y>y>i@aAaACE77777CEaAaAy>y>y>==<<<:::::<==y>y>aACE:l7777S7S7S7S777:l^AaAy>y>===<:::::<==y>y>y>h@aACE77777CEaAaAy>y>===<:::::<=y>y>aAaACE;7777S7S7S7S777;iCEbAy>y>y>==<::::::<===y>y>h@aACE77777CEaAaAy>y>==<<::::<==y>y>aAaACE<7777S7S7S7S7779CEaAi@y>y>y>==<:::::::<<=y>y>fAbACE77777CEaAaAy>y>==<<::::::<=y>y>y>aA^A:l77777S7S7S7S7777;gCEdAdAy>y>==<<::::::<<=y>y>fAbAZACE7777CEaAaAy>y>==<<::::<<==y>y>aAaACE9s77777S7S7S7S7777:CEbAfAy>y>y>==<<:::::<<=y>y>fAbA^ACE7777CEaAaAy>y>==<<:::<<==y>y>y>aAaA;f777777S7S7S7S777799CEi@eAy>y>===<<:::::<=y>y>fAbA^ACE7777CEaAaAy>y>==<<::<<===y>y>aAaACE9s777777S7S7S7S77777;CEdAdAy>y>y>===<:::::<=y>y>fAbA^ACE7777CEaAaAy>y>==<<:<<===y>y>aAaA^A>\9777777S7S7S7S777777:CEfAeAy>y>y>===<:::<<=y>y>fAbAaACE7777CEaAaAy>y>==<<<<===y>y>y>aAaACE:o7777777S7S7S7S7777777CEZAeAfAy>y>y>===<<<<<=y>y>fAbAaACE7777CEaAaAy>y>==<<<<==y>y>y>aAaA^A:l7777777R7S7S7S7S77777777CEWBaAi@y>y>y>===<<<==y>y>fAbAaACE7777CEaAaAy>y>==<<===y>y>y>aAaAaA:o=_7777777R7S7S7S7S777777777CEXBaAh@y>y>y>===<<==y>y>fAbAaACE7777CEaAaAy>y>======y>y>y>aAaAaACE:l77777777R7S7S7S7S7S777777779CE^AdAg@y>y>y>===<==y>y>i@bAaACE9777CEaAaAy>y>=====y>y>y>aAaACECE:o777777777R7S7S7S7S7S7777777779CEZAfAg@y>y>y>y>===y>y>y>h?aACE<7777CEaAaAy>y>===y>y>y>y>aAaAaACE;9777777777R7S7S7S7S7S77777777779CE^AbAfAfAy>y>y>y>y>y>y>fAcAaACE77777CEaAaAy>y>==y>y>y>y>aAaACECE:l77777777777R7S7S7S7S7S777777777777CEPCaAbAh@y>y>y>y>y>dAaAaACE:77777CEaAaAy>y>y>y>y>y>aAaAaACECE:777777777777R7S7S7S7S7S7777777777777CECFaA^AbAg@fAh@i@dAaAZACE977777CEaAaAy>y>y>aAaAaAaACECG;f97777777777777R7S7S7S7S7S777777777777777CECE^AaAbAaAaAaACECE7777777aAaAy>y>y>aAaAaA^ACECE9777777777777777R7S7S7S7S7S77777777777777777=ECECECECECE:7777777CEaAaAy>aAaAaACECE:l;i77777777777777777R7S7S7S7S7S77777777777777777778;97777777CECEaAaAaAaACECECECE<7777777777777777777R7S7S7S7S7S77777777777777777777777777777CECECECECECE789777777777777777777777R7S7S7S7S7S77777777777777777777777777777777777777777777777777777777777R7S7S7S7S7S77777777777777777777777777777777777777777777777777777777777R7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S77777777777777777777777777777777777S7S7S7S7S7S7S7S7S7S7S7S7R7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S @ pdfsam-1.1.4/template-basic-1/ 0000755 0001750 0001750 00000000000 11076707110 015755 5 ustar twerner twerner pdfsam-1.1.4/template-basic-1/config.xml 0000644 0001750 0001750 00000001371 11225341766 017755 0 ustar twerner twerner
PDF Split and Merge basicPDF Split and Merge basic 1.1.412 July 2009Java(TM) 2 SDK, Standard Edition, Version 1.4.2514en_GB1000011Andrea Vacondioandrea.vacondio@gmail.com
pdfsam-1.1.4/template-basic-1/plugins/ 0000755 0001750 0001750 00000000000 10756610774 017453 5 ustar twerner twerner pdfsam-1.1.4/template-basic-1/plugins/mix/ 0000755 0001750 0001750 00000000000 11104627606 020236 5 ustar twerner twerner pdfsam-1.1.4/template-basic-1/plugins/mix/config.xml 0000644 0001750 0001750 00000000224 10717432222 022220 0 ustar twerner twerner
org.pdfsam.plugin.mix.GUI.MixMainGUI
pdfsam-1.1.4/template-basic-1/plugins/split/ 0000755 0001750 0001750 00000000000 10756610774 020606 5 ustar twerner twerner pdfsam-1.1.4/template-basic-1/plugins/split/config.xml 0000644 0001750 0001750 00000000231 10724002432 022546 0 ustar twerner twerner
org.pdfsam.plugin.split.GUI.SplitMainGUI
pdfsam-1.1.4/template-basic-1/plugins/merge/ 0000755 0001750 0001750 00000000000 10756610776 020554 5 ustar twerner twerner pdfsam-1.1.4/template-basic-1/plugins/merge/config.xml 0000644 0001750 0001750 00000000227 10727505560 022534 0 ustar twerner twerner
org.pdfsam.plugin.merge.GUI.MergeMainGUI
pdfsam-1.1.4/install/ 0000755 0001750 0001750 00000000000 11035172252 014371 5 ustar twerner twerner pdfsam-1.1.4/install/install-basic.nsi 0000644 0001750 0001750 00000051657 11225342740 017651 0 ustar twerner twerner Name "pdfsam"
SetCompressor /SOLID zlib
# Defines
!define REGKEY "Software\$(^Name)"
!define VERSION 1.1.4
!define COMPANY "Andrea Vacondio"
!define URL "http://www.pdfsam.org/"
# MUI defines
!define MUI_ICON install-data\install.ico
!define MUI_FINISHPAGE_NOAUTOCLOSE
!define MUI_STARTMENUPAGE_REGISTRY_ROOT "HKLM"
!define MUI_STARTMENUPAGE_REGISTRY_KEY ${REGKEY}
;!define MUI_STARTMENUPAGE_REGISTRY_VALUENAME StartMenuGroup
!define MUI_STARTMENUPAGE_DEFAULTFOLDER "PDF Split And Merge"
!define MUI_WELCOMEFINISHPAGE_BITMAP install-data\install.bmp
!define MUI_UNICON install-data\uninstall.ico
!define MUI_UNFINISHPAGE_NOAUTOCLOSE
!define LANGUAGE_TITLE "pdfsam language selection"
!define MUI_LANGDLL_WINDOWTITLE "${LANGUAGE_TITLE}"
# Remember language for uninstallation
;!define MUI_LANGDLL_REGISTRY_ROOT HKLM
;!define MUI_LANGDLL_REGISTRY_KEY "Software\$(^Name)"
!define MUI_LANGDLL_REGISTRY_VALUENAME lang
# Included files
!include Sections.nsh
!include MUI.nsh
!include "WordFunc.nsh"
!include Library.nsh
!include "WinVer.nsh"
!include "nsDialogs.nsh"
!include "FileFunc.nsh"
#for modern UI functionality
!include "${NSISDIR}\Contrib\Modern UI\System.nsh"
!include "XML.nsh"
;Required functions
!insertmacro GetParameters
!insertmacro GetOptions
!insertmacro un.GetParameters
!insertmacro un.GetOptions
;--------------------------------
# Variables
Var StartMenuGroup
Var LANG_NAME
;user control
Var ALL_USERS
Var ALL_USERS_FIXED
Var ALL_USERS_BUTTON
Var IS_ADMIN
Var USERNAME
; uninstaller variables
Var un.REMOVE_ALL_USERS
Var un.REMOVE_CURRENT_USER
;-------------------
# Installer pages
!insertmacro MUI_PAGE_WELCOME
!insertmacro MUI_PAGE_LICENSE install-data\gpl.txt
Page custom PageAllUsers PageLeaveAllUsers ;call the user admin stuff
!insertmacro MUI_PAGE_DIRECTORY
!insertmacro MUI_PAGE_STARTMENU Application $StartMenuGroup
!insertmacro MUI_PAGE_INSTFILES
!insertmacro MUI_PAGE_FINISH
!define MUI_PAGE_CUSTOMFUNCTION_PRE un.ConfirmPagePre ;for fancy uninstall
!insertmacro MUI_UNPAGE_CONFIRM
!insertmacro MUI_UNPAGE_INSTFILES
!define MUI_PAGE_CUSTOMFUNCTION_PRE un.FinishPagePre ;for fancy uninstall
!insertmacro MUI_UNPAGE_FINISH
# Installer languages
!insertmacro MUI_LANGUAGE "English" # first language is the default language
!insertmacro MUI_LANGUAGE "Bosnian"
!insertmacro MUI_LANGUAGE "Bulgarian"
!insertmacro MUI_LANGUAGE "Croatian"
!insertmacro MUI_LANGUAGE "Catalan"
!insertmacro MUI_LANGUAGE "Czech"
!insertmacro MUI_LANGUAGE "Danish"
!insertmacro MUI_LANGUAGE "Galician"
!insertmacro MUI_LANGUAGE "German"
!insertmacro MUI_LANGUAGE "Greek"
!insertmacro MUI_LANGUAGE "Spanish"
!insertmacro MUI_LANGUAGE "Farsi"
!insertmacro MUI_LANGUAGE "Finnish"
!insertmacro MUI_LANGUAGE "French"
!insertmacro MUI_LANGUAGE "Hebrew"
!insertmacro MUI_LANGUAGE "Hungarian"
!insertmacro MUI_LANGUAGE "Indonesian"
!insertmacro MUI_LANGUAGE "Italian"
!insertmacro MUI_LANGUAGE "Japanese"
!insertmacro MUI_LANGUAGE "Korean"
!insertmacro MUI_LANGUAGE "Latvian"
!insertmacro MUI_LANGUAGE "Lithuanian"
!insertmacro MUI_LANGUAGE "Norwegian"
!insertmacro MUI_LANGUAGE "Dutch"
!insertmacro MUI_LANGUAGE "Polish"
!insertmacro MUI_LANGUAGE "Portuguese"
!insertmacro MUI_LANGUAGE "PortugueseBR"
!insertmacro MUI_LANGUAGE "Russian"
!insertmacro MUI_LANGUAGE "Slovak"
!insertmacro MUI_LANGUAGE "Slovenian"
!insertmacro MUI_LANGUAGE "Swedish"
!insertmacro MUI_LANGUAGE "Thai"
!insertmacro MUI_LANGUAGE "Turkish"
!insertmacro MUI_LANGUAGE "Ukrainian"
!insertmacro MUI_LANGUAGE "SimpChinese"
!insertmacro MUI_LANGUAGE "TradChinese"
# Installer attributes
OutFile pdfsam-win32inst-v1_1_4.exe
InstallDir "$PROGRAMFILES\pdfsam"
CRCCheck on
XPStyle on
ShowInstDetails show
VIProductVersion 1.1.4.0
RequestExecutionLevel highest
VIAddVersionKey /LANG=${LANG_ENGLISH} ProductName "pdfsam"
VIAddVersionKey /LANG=${LANG_ENGLISH} ProductVersion "${VERSION}"
VIAddVersionKey /LANG=${LANG_ENGLISH} CompanyName "${COMPANY}"
VIAddVersionKey /LANG=${LANG_ENGLISH} FileVersion "${VERSION}"
VIAddVersionKey /LANG=${LANG_ENGLISH} FileDescription ""
VIAddVersionKey /LANG=${LANG_ENGLISH} LegalCopyright "2009"
;InstallDirRegKey HKLM "${REGKEY}" Path
ShowUninstDetails hide
!define getLanguageName "!insertmacro getLanguageName"
#macro that resolves an id to an actual language
!macro getLanguageName code
Push ${code}
Call getLangName
!macroend
;function that gets called by the above macro
Function getLangName ;pretty sure there's a better way to do this...
ClearErrors
Pop $0
${Switch} $0
${Case} ${LANG_ENGLISH}
Push 'en_GB'
${Break}
${Case} ${LANG_ITALIAN}
Push 'it'
${Break}
${Case} ${LANG_BULGARIAN}
Push 'bg'
${Break}
${Case} ${LANG_BOSNIAN}
Push 'bs'
${Break}
${Case} ${LANG_CATALAN}
Push 'ca'
${Break}
${Case} ${LANG_CROATIAN}
Push 'hr'
${Break}
${Case} ${LANG_CZECH}
Push 'cs'
${Break}
${Case} ${LANG_SLOVAK}
Push 'sk'
${Break}
${Case} ${LANG_ITALIAN}
Push 'it'
${Break}
${Case} ${LANG_HEBREW}
Push 'he'
${Break}
${Case} ${LANG_RUSSIAN}
Push 'ru'
${Break}
${Case} ${LANG_NORWEGIAN}
Push 'nb'
${Break}
${Case} ${LANG_SWEDISH}
Push 'sv'
${Break}
${Case} ${LANG_SPANISH}
Push 'es'
${Break}
${Case} ${LANG_PORTUGUESE}
Push 'pt_PT'
${Break}
${Case} ${LANG_DUTCH}
Push 'nl'
${Break}
${Case} ${LANG_FRENCH}
Push 'fr'
${Break}
${Case} ${LANG_GREEK}
Push 'el'
${Break}
${Case} ${LANG_TURKISH}
Push 'tr'
${Break}
${Case} ${LANG_GERMAN}
Push 'de'
${Break}
${Case} ${LANG_POLISH}
Push 'pl'
${Break}
${Case} ${LANG_FINNISH}
Push 'fi'
${Break}
${Case} ${LANG_SIMPCHINESE}
Push 'zh_CN'
${Break}
${Case} ${LANG_HUNGARIAN}
Push 'hu'
${Break}
${Case} ${LANG_DANISH}
Push 'da'
${Break}
${Case} ${LANG_TRADCHINESE}
Push 'zh_TW'
${Break}
${Case} ${LANG_INDONESIAN}
Push 'id'
${Break}
${Case} ${LANG_FARSI}
Push 'fa'
${Break}
${Case} ${LANG_KOREAN}
Push 'ko'
${Break}
${Case} ${LANG_THAI}
Push 'th'
${Break}
${Case} ${LANG_GALICIAN}
Push 'gl'
${Break}
${Case} ${LANG_JAPANESE}
Push 'ja'
${Break}
${Case} ${LANG_LATVIAN}
Push 'lv'
${Break}
${Case} ${LANG_LITHUANIAN}
Push 'lt'
${Break}
${Case} ${LANG_UKRAINIAN}
Push 'uk'
${Break}
${Case} ${LANG_SLOVENIAN}
Push 'sl'
${Break}
${Default}
Push 'Default'
${Break}
${EndSwitch}
Pop $LANG_NAME
FunctionEnd
Function WarnDirExists
IfFileExists $INSTDIR\*.* DirExists DirExistsOK
DirExists:
MessageBox MB_YESNO|MB_ICONQUESTION|MB_DEFBUTTON2 \
"Installation directory already exists, please uninstall any previous installed version.$\nWould you like to install anyway?" \
IDYES DirExistsOK
Abort
DirExistsOK:
FunctionEnd
# Installer sections
Section "-Install Section" SEC0000
Call WarnDirExists
SetOutPath $INSTDIR
SetOverwrite on
File /r F:\pdfsam\pdfsam-basic\*
;WriteRegStr HKLM "${REGKEY}\Components" "Install Section" 1
SectionEnd
Section -post SEC0001
SetOutPath $INSTDIR
WriteUninstaller $INSTDIR\uninstall.exe
!insertmacro MUI_STARTMENU_WRITE_BEGIN Application
CreateDirectory "$SMPROGRAMS\$StartMenuGroup"
SetOutPath $INSTDIR
;use the INSTDIR outpath for the next shortcut in order to launch the JAR file properly
CreateShortcut "$SMPROGRAMS\$StartMenuGroup\pdfsam.lnk" $INSTDIR\pdfsam-starter.exe
SetOutPath $SMPROGRAMS\$StartMenuGroup
CreateShortcut "$SMPROGRAMS\$StartMenuGroup\Readme.lnk" $INSTDIR\doc\readme.txt
CreateShortcut "$SMPROGRAMS\$StartMenuGroup\Tutorial.lnk" $INSTDIR\doc\pdfsam-1.1.0-tutorial.pdf
CreateShortcut "$SMPROGRAMS\$StartMenuGroup\Uninstall.lnk" $INSTDIR\uninstall.exe
!insertmacro MUI_STARTMENU_WRITE_END
WriteRegStr SHCTX "Software\$(^Name)" "" $INSTDIR
WriteRegStr SHCTX "Software\$(^Name)" "Version" "${VERSION}"
WriteRegExpandStr SHCTX "Software\Microsoft\Windows\CurrentVersion\Uninstall\$(^Name)" "InstallLocation" "$INSTDIR"
WriteRegExpandStr SHCTX "Software\Microsoft\Windows\CurrentVersion\Uninstall\$(^Name)" UninstallString $INSTDIR\uninstall.exe
WriteRegStr SHCTX "Software\Microsoft\Windows\CurrentVersion\Uninstall\$(^Name)" DisplayName "$(^Name)"
WriteRegStr SHCTX "Software\Microsoft\Windows\CurrentVersion\Uninstall\$(^Name)" DisplayVersion "${VERSION}"
WriteRegStr SHCTX "Software\Microsoft\Windows\CurrentVersion\Uninstall\$(^Name)" DisplayIcon $INSTDIR\uninstall.exe
WriteRegStr SHCTX "Software\Microsoft\Windows\CurrentVersion\Uninstall\$(^Name)" "URLInfoAbout" "${URL}"
WriteRegDWORD SHCTX "Software\Microsoft\Windows\CurrentVersion\Uninstall\$(^Name)" NoModify 1
WriteRegDWORD SHCTX "Software\Microsoft\Windows\CurrentVersion\Uninstall\$(^Name)" NoRepair 1
SectionEnd
Section "-Write XML" ;writes to XML file
${xml::LoadFile} $INSTDIR\config.xml $0
${xml::GotoPath} "/pdfsam/settings/i18n" $0
${getLanguageName} $LANGUAGE
${xml::SetText} $LANG_NAME $1
${xml::SaveFile} "$INSTDIR\config.xml" $0
SectionEnd
# Uninstaller sections
Section "Uninstall"
Delete "$INSTDIR\uninstall.exe"
Delete "$INSTDIR\config.xml"
Delete "$INSTDIR\pdfsam-starter.exe"
Delete "$INSTDIR\*.jar"
RMDir /r "$INSTDIR\lib"
RMDir /r "$INSTDIR\bin"
RMDir /r "$INSTDIR\plugins"
RMDir /r "$INSTDIR\doc"
RMDir "$INSTDIR"
${If} $un.REMOVE_ALL_USERS == 1
SetShellVarContext all
${EndIf}
${If} $un.REMOVE_CURRENT_USER == 1
SetShellVarContext current
${EndIf}
Call un.RemoveStartmenu
DeleteRegKey SHCTX "Software\Microsoft\Windows\CurrentVersion\Uninstall\$(^Name)"
DeleteRegKey SHCTX "Software\$(^Name)"
SectionEnd
;This part controls installation for the current user / for all users
Function GetUserInfo
ClearErrors
UserInfo::GetName
${If} ${Errors}
StrCpy $IS_ADMIN 1
Return
${EndIf}
Pop $USERNAME
UserInfo::GetAccountType
Pop $R0
${Switch} $R0
${Case} "Admin"
${Case} "Power"
StrCpy $IS_ADMIN 1
${Break}
${Default}
StrCpy $IS_ADMIN 0
${Break}
${EndSwitch}
FunctionEnd
Function ReadAllUsersCommandline
${GetParameters} $R0
${GetOptions} $R0 "/user" $R1
${Unless} ${Errors}
${If} $R1 == "current"
${OrIf} $R1 == "=current"
${If} $ALL_USERS_FIXED == 1
${AndIf} $ALL_USERS == 1
MessageBox MB_ICONSTOP "Cannot install for current user only. pdfsam has been previously installed for all users.$\nPlease install this version for all users or uninstall previous version first."
Abort
${EndIf}
SetShellVarContext current
StrCpy $ALL_USERS 0
StrCpy $ALL_USERS_FIXED 1
${ElseIf} $R1 == "all"
${OrIf} $R1 == "=all"
${If} $ALL_USERS_FIXED == 1
${AndIf} $ALL_USERS == 0
MessageBox MB_ICONSTOP "Cannot install for all users. pdfsam has been previously installed for the current user only.$\nPlease install this version for the current user only or uninstall previous version first."
Abort
${EndIf}
StrCpy $ALL_USERS 1
StrCpy $ALL_USERS_FIXED 1
SetShellVarContext all
${Else}
MessageBox MB_ICONSTOP "Invalid option for /user. Has to be either /user=all or /user=current"
Abort
${EndIf}
${EndUnless}
FunctionEnd
Function PageAllUsers
!insertmacro MUI_HEADER_TEXT "Choose Installation Options" "Who should this application be installed for?"
nsDialogs::Create /NOUNLOAD 1018
Pop $0
nsDialogs::CreateItem /NOUNLOAD STATIC ${WS_VISIBLE}|${WS_CHILD}|${WS_CLIPSIBLINGS} 0 0 0 100% 30 "Please select whether you wish to make this software available to all users or just yourself."
Pop $R0
${If} $IS_ADMIN == 1
${If} $ALL_USERS_FIXED == 1
${AndIf} $ALL_USERS == 0
StrCpy $R2 ${BS_AUTORADIOBUTTON}|${BS_VCENTER}|${BS_MULTILINE}|${WS_VISIBLE}|${WS_CHILD}|${WS_CLIPSIBLINGS}|${WS_GROUP}|${WS_TABSTOP}|${WS_DISABLED}
${Else}
StrCpy $R2 ${BS_AUTORADIOBUTTON}|${BS_VCENTER}|${BS_MULTILINE}|${WS_VISIBLE}|${WS_CHILD}|${WS_CLIPSIBLINGS}|${WS_GROUP}|${WS_TABSTOP}
${EndIf}
${Else}
StrCpy $R2 ${BS_AUTORADIOBUTTON}|${BS_VCENTER}|${BS_MULTILINE}|${WS_VISIBLE}|${WS_CHILD}|${WS_CLIPSIBLINGS}|${WS_GROUP}|${WS_TABSTOP}|${WS_DISABLED}
${EndIf}
nsDialogs::CreateItem /NOUNLOAD BUTTON $R2 0 10 55 100% 30 "&Anyone who uses this computer (all users)"
Pop $ALL_USERS_BUTTON
${If} $ALL_USERS_FIXED == 1
${AndIf} $ALL_USERS == 1
StrCpy $R2 ${BS_AUTORADIOBUTTON}|${BS_TOP}|${BS_MULTILINE}|${WS_VISIBLE}|${WS_CHILD}|${WS_CLIPSIBLINGS}|${WS_DISABLED}
${Else}
StrCpy $R2 ${BS_AUTORADIOBUTTON}|${BS_TOP}|${BS_MULTILINE}|${WS_VISIBLE}|${WS_CHILD}|${WS_CLIPSIBLINGS}
${EndIf}
${If} $USERNAME != ""
nsDialogs::CreateItem /NOUNLOAD BUTTON $R2 0 10 85 100% 50 "&Only for me ($USERNAME)"
${Else}
nsDialogs::CreateItem /NOUNLOAD BUTTON $R2 0 10 85 100% 50 "&Only for me"
${EndIf}
Pop $R0
${If} $ALL_USERS_FIXED == 1
${If} $ALL_USERS == 1
nsDialogs::CreateItem /NOUNLOAD STATIC ${WS_VISIBLE}|${WS_CHILD}|${WS_CLIPSIBLINGS} 0 0 -30 100% 30 "pdfsam has been previously installed for all users. Please uninstall first before changing setup type."
${Else}
nsDialogs::CreateItem /NOUNLOAD STATIC ${WS_VISIBLE}|${WS_CHILD}|${WS_CLIPSIBLINGS} 0 0 -30 100% 30 "pdfsam has been previously installed for this user only. Please uninstall first before changing setup type."
${EndIf}
${Else}
nsDialogs::CreateItem /NOUNLOAD STATIC ${WS_VISIBLE}|${WS_CHILD}|${WS_CLIPSIBLINGS} 0 0 -30 100% 30 "Installation for all users requires Administrator privileges."
${EndIf}
Pop $R1
${If} $ALL_USERS == "1"
SendMessage $ALL_USERS_BUTTON ${BM_SETCHECK} 1 0
${Else}
SendMessage $R0 ${BM_SETCHECK} 1 0
${EndIf}
nsDialogs::Show
FunctionEnd
Function PageLeaveAllUsers
SendMessage $ALL_USERS_BUTTON ${BM_GETCHECK} 0 0 $R0
${If} $R0 == 0
StrCpy $ALL_USERS "0"
SetShellVarContext current
${Else}
StrCpy $ALL_USERS "1"
SetShellVarContext all
${EndIf}
FunctionEnd
;end user control-----------------------------------------------------------------
# Installer functions
Function .onInit
;prevent multiple instances of the installer
System::Call 'kernel32::CreateMutexA(i 0, i 0, t "myNSISMutex") i .r1 ?e'
Pop $R0
StrCmp $R0 0 +3
MessageBox MB_OK|MB_ICONEXCLAMATION "The installer is already running."
Abort
;Language selection dialog
Push ""
Push ${LANG_ENGLISH}
Push English
Push ${LANG_ITALIAN}
Push Italian
Push ${LANG_RUSSIAN}
Push Russian
Push ${LANG_BULGARIAN}
Push Bulgarian
Push ${LANG_SWEDISH}
Push Swedish
Push ${LANG_SPANISH}
Push Spanish
Push ${LANG_PORTUGUESE}
Push Portuguese
Push ${LANG_DUTCH}
Push Dutch
Push ${LANG_FRENCH}
Push French
Push ${LANG_GERMAN}
Push German
Push ${LANG_GALICIAN}
Push Galician
Push ${LANG_GREEK}
Push Greek
Push ${LANG_NORWEGIAN}
Push Norwegian
Push ${LANG_TURKISH}
Push Turkish
Push ${LANG_POLISH}
Push Polish
Push ${LANG_FINNISH}
Push Finnish
Push ${LANG_SIMPCHINESE}
Push SimpChinese
Push ${LANG_HUNGARIAN}
Push Hungarian
Push ${LANG_DANISH}
Push Danish
Push ${LANG_FARSI}
Push Farsi
Push ${LANG_KOREAN}
Push Korean
Push ${LANG_JAPANESE}
Push Japanese
Push ${LANG_LATVIAN}
Push Latvian
Push ${LANG_LITHUANIAN}
Push Lithuanian
Push ${LANG_TRADCHINESE}
Push TradChinese
Push ${LANG_INDONESIAN}
Push Indonesian
Push ${LANG_BOSNIAN}
Push Bosnian
Push ${LANG_CZECH}
Push Czech
Push ${LANG_SLOVAK}
Push Slovak
Push ${LANG_THAI}
Push Thai
Push ${LANG_CATALAN}
Push Catalan
Push ${LANG_UKRAINIAN}
Push Ukrainian
Push ${LANG_CROATIAN}
Push Croatian
Push ${LANG_HEBREW}
Push Hebrew
Push ${LANG_SLOVENIAN}
Push Slovenian
Push A ; A means auto count languages
; for the auto count to work the first empty push (Push "") must remain
LangDLL::LangDialog "Installer Language" "Please select the language of the installer"
Call GetUserInfo
Call ReadAllUsersCommandline
${If} $ALL_USERS == 1
${If} $IS_ADMIN == 0
${If} $ALL_USERS_FIXED == 1
MessageBox MB_ICONSTOP "pdfsam has been previously installed for all users.$\nPlease restart the installer with Administrator privileges."
Abort
${Else}
StrCpy $All_USERS 0
${EndIf}
${EndIf}
${EndIf}
Pop $LANGUAGE
StrCmp $LANGUAGE "cancel" 0 +2
Abort
FunctionEnd
# Uninstaller functions
Function un.onInit
;copied
Call un.GetUserInfo
Call un.ReadPreviousVersion
${If} $un.REMOVE_ALL_USERS == 1
${AndIf} $IS_ADMIN == 0
MessageBox MB_ICONSTOP "$(^Name) has been installed for all users.$\nPlease restart the uninstaller with Administrator privileges to remove it."
Abort
${EndIf}
;------------
!insertmacro MUI_UNGETLANGUAGE
;TODO insert language dependent uninstall string below
;TODO uninstall prompt should not display location where files are being removed from
MessageBox MB_ICONQUESTION|MB_YESNO|MB_DEFBUTTON2 "Are you sure you want to completely remove $(^Name)?" IDYES +2
Abort
FunctionEnd
Function un.ReadPreviousVersion
ReadRegStr $R0 HKLM "Software\$(^Name)" ""
${If} $R0 != ""
;Detect version
ReadRegStr $R2 HKLM "Software\$(^Name)" "Version"
${If} $R2 == ""
StrCpy $R0 ""
${EndIf}
${EndIf}
ReadRegStr $R1 HKCU "Software\$(^Name)" ""
${If} $R1 != ""
;Detect version
ReadRegStr $R2 HKCU "Software\$(^Name)" "Version"
${If} $R2 == ""
StrCpy $R1 ""
${EndIf}
${EndIf}
${If} $R1 == $INSTDIR
Strcpy $un.REMOVE_CURRENT_USER 1
${EndIf}
${If} $R0 == $INSTDIR
Strcpy $un.REMOVE_ALL_USERS 1
${EndIf}
${If} $un.REMOVE_CURRENT_USER != 1
${AndIf} $un.REMOVE_ALL_USERS != 1
${If} $R1 != ""
Strcpy $un.REMOVE_CURRENT_USER 1
${If} $R0 == $R1
Strcpy $un.REMOVE_ALL_USERS 1
${EndIf}
${Else}
StrCpy $un.REMOVE_ALL_USERS = 1
${EndIf}
${EndIf}
FunctionEnd
Function un.RemoveStartmenu
!insertmacro MUI_STARTMENU_GETFOLDER Application $StartMenuGroup
Delete "$SMPROGRAMS\$StartMenuGroup\Uninstall.lnk"
Delete "$SMPROGRAMS\$StartMenuGroup\pdfsam.lnk"
Delete "$SMPROGRAMS\$StartMenuGroup\readme.lnk"
Delete "$SMPROGRAMS\$StartMenuGroup\tutorial.lnk"
RMDir "$SMPROGRAMS\$StartMenuGroup"
FunctionEnd
;fancy uninstaller sections
Function un.onUninstSuccess
HideWindow
;if we want a box saying "pdfsam completely removed we will uncomment below"
;MessageBox MB_ICONINFORMATION|MB_OK "$(^Name) completely removed."
FunctionEnd
Function un.GetUserInfo
ClearErrors
UserInfo::GetName
${If} ${Errors}
StrCpy $IS_ADMIN 1
Return
${EndIf}
Pop $USERNAME
UserInfo::GetAccountType
Pop $R0
${Switch} $R0
${Case} "Admin"
${Case} "Power"
StrCpy $IS_ADMIN 1
${Break}
${Default}
StrCpy $IS_ADMIN 0
${Break}
${EndSwitch}
FunctionEnd
Function un.ConfirmPagePre
${un.GetParameters} $R0
${un.GetOptions} $R0 "/frominstall" $R1
${Unless} ${Errors}
Abort
${EndUnless}
FunctionEnd
Function un.FinishPagePre
${un.GetParameters} $R0
${un.GetOptions} $R0 "/frominstall" $R1
${Unless} ${Errors}
SetRebootFlag false
Abort
${EndUnless}
FunctionEnd
;--------------------------
pdfsam-1.1.4/pdfsam-merge/ 0000755 0001750 0001750 00000000000 10727477004 015304 5 ustar twerner twerner pdfsam-1.1.4/pdfsam-merge/ant/ 0000755 0001750 0001750 00000000000 10727477156 016076 5 ustar twerner twerner pdfsam-1.1.4/pdfsam-merge/ant/build.properties 0000644 0001750 0001750 00000000740 11207771516 021303 0 ustar twerner twerner #where classes are compiled, jars distributed, javadocs created and release created
build.dir=f:/build
#libraries
libs.dir=F:/pdfsam/workspace-enhanced/pdfsam-maine/lib
pdfsam.release.jar.dir=f:/build/pdfsam-maine/release/jar
log4j.jar.name=log4j-1.2.15
dom4j.jar.name=dom4j-1.6.1
jaxen.jar.name=jaxen-1.1
pdfsam-console.jar.name=pdfsam-console-1.1.2e
pdfsam-merge.jar.name=pdfsam-merge-0.7.0
pdfsam-langpack.jar.name=pdfsam-langpack
pdfsam.jar.name=pdfsam-1.0.0-b3
pdfsam-1.1.4/pdfsam-merge/ant/build.xml 0000644 0001750 0001750 00000007164 10757576626 017734 0 ustar twerner twerner
Merge plugin for pdfsam
pdfsam-1.1.4/pdfsam-merge/apidocs/ 0000755 0001750 0001750 00000000000 11225360214 016712 5 ustar twerner twerner pdfsam-1.1.4/pdfsam-merge/images/ 0000755 0001750 0001750 00000000000 10727477156 016561 5 ustar twerner twerner pdfsam-1.1.4/pdfsam-merge/images/saveXml.png 0000644 0001750 0001750 00000000624 11013606756 020675 0 ustar twerner twerner PNG
IHDR a sRGB bKGD Z } pHYs & &% tIME &;NL tEXtComment Created with GIMPW IDAT8c p#?h #3c300000000v td>.6 tm اlN˺BHn :q2} ^`4FF&u bl]> +q{7nr
b`[I>p Lb頻 $:`, ݿЇY|=QR_
xa3^(liˍ-
v1e$W EP
g IENDB` pdfsam-1.1.4/pdfsam-merge/images/merge.png 0000644 0001750 0001750 00000000513 10727477160 020360 0 ustar twerner twerner PNG
IHDR a bKGD pHYs !3 tIME*%} IDAT8˝
0Jvá gű>Ic})cM*, M#GO$B uPlij-V )Cx NR a9dmIGP N~1!~(}L2;'ey?77SkL~$?gɦ_1-?#LHnH'p$WA( ;]? IENDB` pdfsam-1.1.4/pdfsam-merge/src/ 0000755 0001750 0001750 00000000000 10727477162 016100 5 ustar twerner twerner pdfsam-1.1.4/pdfsam-merge/src/java/ 0000755 0001750 0001750 00000000000 10727477202 017014 5 ustar twerner twerner pdfsam-1.1.4/pdfsam-merge/src/java/org/ 0000755 0001750 0001750 00000000000 10727477320 017604 5 ustar twerner twerner pdfsam-1.1.4/pdfsam-merge/src/java/org/pdfsam/ 0000755 0001750 0001750 00000000000 10727477320 021056 5 ustar twerner twerner pdfsam-1.1.4/pdfsam-merge/src/java/org/pdfsam/plugin/ 0000755 0001750 0001750 00000000000 10727477320 022354 5 ustar twerner twerner pdfsam-1.1.4/pdfsam-merge/src/java/org/pdfsam/plugin/merge/ 0000755 0001750 0001750 00000000000 10727477320 023453 5 ustar twerner twerner pdfsam-1.1.4/pdfsam-merge/src/java/org/pdfsam/plugin/merge/components/ 0000755 0001750 0001750 00000000000 11001121500 025604 5 ustar twerner twerner pdfsam-1.1.4/pdfsam-merge/src/java/org/pdfsam/plugin/merge/components/JSaveListAsXmlMenuItem.java 0000644 0001750 0001750 00000012025 11104613632 032744 0 ustar twerner twerner /*
* Created on 15-Apr-2008
* Copyright (C) 20078 by Andrea Vacondio.
*
* This program 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 2 of the License.
* This program 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 this program;
* if not, write to the Free Software Foundation, Inc.,
* 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.pdfsam.plugin.merge.components;
import java.awt.event.MouseAdapter;
import java.awt.event.MouseEvent;
import java.io.BufferedOutputStream;
import java.io.File;
import java.io.FileOutputStream;
import javax.swing.ImageIcon;
import javax.swing.JFileChooser;
import javax.swing.JMenuItem;
import org.apache.log4j.Logger;
import org.dom4j.Document;
import org.dom4j.DocumentHelper;
import org.dom4j.Element;
import org.dom4j.io.OutputFormat;
import org.dom4j.io.XMLWriter;
import org.pdfsam.guiclient.commons.panels.JPdfSelectionPanel;
import org.pdfsam.guiclient.configuration.Configuration;
import org.pdfsam.guiclient.dto.PdfSelectionTableItem;
import org.pdfsam.guiclient.utils.filters.XmlFilter;
import org.pdfsam.i18n.GettextResource;
/**
* Menu item to add the "save as xml" capability to the JPdfSelectionPanel
* @author Andrea Vacondio
*/
public class JSaveListAsXmlMenuItem extends JMenuItem {
private static final long serialVersionUID = -2401309408949258117L;
private static final Logger log = Logger.getLogger(JSaveListAsXmlMenuItem.class.getPackage().getName());
private JPdfSelectionPanel selectionPanel;
private JFileChooser fileChooser = null;;
/**
* @param selectionPanel
*/
public JSaveListAsXmlMenuItem(JPdfSelectionPanel selectionPanel) {
super();
this.selectionPanel = selectionPanel;
this.init();
}
/**
* initialize
*/
private void init(){
setIcon(new ImageIcon(this.getClass().getResource("/images/saveXml.png")));
setText(GettextResource.gettext(Configuration.getInstance().getI18nResourceBundle(),"Export as xml"));
addMouseListener(new MouseAdapter() {
public void mouseReleased(MouseEvent e) {
PdfSelectionTableItem[] rows = selectionPanel.getTableRows();
if (rows != null && rows.length>0){
try{
lazyInitJFileChooser();
if (fileChooser.showSaveDialog(selectionPanel) == JFileChooser.APPROVE_OPTION) {
File selectedFile = fileChooser.getSelectedFile();
if(selectedFile.getName().toLowerCase().lastIndexOf(".xml") == -1){
selectedFile = new File(selectedFile.getParent(), selectedFile.getName()+".xml");
}
writeXmlFile(rows, selectedFile);
}
}
catch (Exception ex){
log.error(GettextResource.gettext(Configuration.getInstance().getI18nResourceBundle(),"Unable to save xml file."), ex);
}
}
}
});
}
/**
* lazily initialize the JFileChooser
*/
private void lazyInitJFileChooser(){
if(fileChooser == null){
fileChooser = new JFileChooser(Configuration.getInstance().getDefaultWorkingDir());
fileChooser.setFileFilter(new XmlFilter());
fileChooser.setApproveButtonText(GettextResource.gettext(Configuration.getInstance().getI18nResourceBundle(), "Ok"));
}
}
/**
* Save the xml file
* @param rows
* @param selectedFile
* @throws Exception
*/
public void writeXmlFile(PdfSelectionTableItem[] rows, File selectedFile) throws Exception{
if (selectedFile != null && rows != null){
Document document = DocumentHelper.createDocument();
Element root = document.addElement("filelist");
for (int i = 0; i0){
node.addAttribute("password", pwd);
}
}
BufferedOutputStream bos = new BufferedOutputStream(new FileOutputStream(selectedFile));
OutputFormat format = OutputFormat.createPrettyPrint();
format.setEncoding("UTF-8");
XMLWriter xmlWriter = new XMLWriter(bos, format);
xmlWriter.write(document);
xmlWriter.flush();
xmlWriter.close();
log.info(GettextResource.gettext(Configuration.getInstance().getI18nResourceBundle(), "File xml saved."));
}else{
log.error(GettextResource.gettext(Configuration.getInstance().getI18nResourceBundle(), "Error saving xml file, output file is null."));
}
}
}
pdfsam-1.1.4/pdfsam-merge/src/java/org/pdfsam/plugin/merge/GUI/ 0000755 0001750 0001750 00000000000 10727477346 024107 5 ustar twerner twerner pdfsam-1.1.4/pdfsam-merge/src/java/org/pdfsam/plugin/merge/GUI/MergeMainGUI.java 0000644 0001750 0001750 00000077150 11177610430 027154 0 ustar twerner twerner /*
* Created on 06-Feb-2006
* Copyright (C) 2006 by Andrea Vacondio.
*
* This program 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 2 of the License.
* This program 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 this program;
* if not, write to the Free Software Foundation, Inc.,
* 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.pdfsam.plugin.merge.GUI;
import java.awt.Component;
import java.awt.Container;
import java.awt.Dimension;
import java.awt.FocusTraversalPolicy;
import java.awt.GridBagConstraints;
import java.awt.GridBagLayout;
import java.awt.Insets;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.beans.PropertyChangeEvent;
import java.beans.PropertyChangeListener;
import java.io.File;
import java.util.LinkedList;
import java.util.List;
import java.util.regex.Pattern;
import javax.swing.BorderFactory;
import javax.swing.JButton;
import javax.swing.JCheckBox;
import javax.swing.JFileChooser;
import javax.swing.JLabel;
import javax.swing.JOptionPane;
import javax.swing.JPanel;
import javax.swing.JTextField;
import javax.swing.SpringLayout;
import org.apache.log4j.Logger;
import org.dom4j.Element;
import org.dom4j.Node;
import org.pdfsam.console.business.dto.commands.AbstractParsedCommand;
import org.pdfsam.console.business.dto.commands.ConcatParsedCommand;
import org.pdfsam.console.business.parser.validators.ConcatCmdValidator;
import org.pdfsam.guiclient.business.listeners.EnterDoClickListener;
import org.pdfsam.guiclient.commons.business.SoundPlayer;
import org.pdfsam.guiclient.commons.business.WorkExecutor;
import org.pdfsam.guiclient.commons.business.WorkThread;
import org.pdfsam.guiclient.commons.business.listeners.CompressCheckBoxItemListener;
import org.pdfsam.guiclient.commons.components.CommonComponentsFactory;
import org.pdfsam.guiclient.commons.components.JPdfVersionCombo;
import org.pdfsam.guiclient.commons.models.AbstractPdfSelectionTableModel;
import org.pdfsam.guiclient.commons.panels.JPdfSelectionPanel;
import org.pdfsam.guiclient.configuration.Configuration;
import org.pdfsam.guiclient.dto.PdfSelectionTableItem;
import org.pdfsam.guiclient.dto.StringItem;
import org.pdfsam.guiclient.exceptions.LoadJobException;
import org.pdfsam.guiclient.exceptions.SaveJobException;
import org.pdfsam.guiclient.gui.components.JHelpLabel;
import org.pdfsam.guiclient.plugins.interfaces.AbstractPlugablePanel;
import org.pdfsam.guiclient.utils.DialogUtility;
import org.pdfsam.guiclient.utils.filters.PdfFilter;
import org.pdfsam.i18n.GettextResource;
import org.pdfsam.plugin.merge.components.JSaveListAsXmlMenuItem;
/**
* Plugable JPanel provides a GUI for merge functions.
* @author Andrea Vacondio
* @see javax.swing.JPanel
*/
public class MergeMainGUI extends AbstractPlugablePanel implements PropertyChangeListener{
private static final String DEFAULT_OUPUT_NAME = "merged_file.pdf";
private static final long serialVersionUID = -992513717368544272L;
private static final Logger log = Logger.getLogger(MergeMainGUI.class.getPackage().getName());
private JTextField destinationTextField = CommonComponentsFactory.getInstance().createTextField(CommonComponentsFactory.DESTINATION_TEXT_FIELD_TYPE);
private JFileChooser browseDestFileChooser;
private SpringLayout layoutDestinationPanel;
private JPanel destinationPanel = new JPanel();
private SpringLayout layoutOptionPanel;
private JPanel optionPanel = new JPanel();
private JHelpLabel mergeTypeHelpLabel;
private JHelpLabel destinationHelpLabel;
private Configuration config;
private JCheckBox mergeTypeCheck = new JCheckBox();
private JPdfVersionCombo versionCombo = new JPdfVersionCombo();
private JPdfSelectionPanel selectionPanel = new JPdfSelectionPanel(JPdfSelectionPanel.UNLIMTED_SELECTABLE_FILE_NUMBER, AbstractPdfSelectionTableModel.MAX_COLUMNS_NUMBER);
private JPanel topPanel = new JPanel();
//button
private final JButton browseDestButton = CommonComponentsFactory.getInstance().createButton(CommonComponentsFactory.BROWSE_BUTTON_TYPE);
private final JButton runButton = CommonComponentsFactory.getInstance().createButton(CommonComponentsFactory.RUN_BUTTON_TYPE);
//checks
private final JCheckBox overwriteCheckbox = CommonComponentsFactory.getInstance().createCheckBox(CommonComponentsFactory.OVERWRITE_CHECKBOX_TYPE);
private final JCheckBox outputCompressedCheck = CommonComponentsFactory.getInstance().createCheckBox(CommonComponentsFactory.COMPRESS_CHECKBOX_TYPE);
//keylisteners
private final EnterDoClickListener runEnterKeyListener = new EnterDoClickListener(runButton);
private final EnterDoClickListener browseEnterKeyListener = new EnterDoClickListener(browseDestButton);
//focus policy
private final MergeFocusPolicy mergeFocusPolicy = new MergeFocusPolicy();
private final JLabel outputVersionLabel = CommonComponentsFactory.getInstance().createLabel(CommonComponentsFactory.PDF_VERSION_LABEL);
private static final String PLUGIN_AUTHOR = "Andrea Vacondio";
private static final String PLUGIN_VERSION = "0.7.0";
private static final String ALL_STRING = "All";
/**
* Constructor
*/
public MergeMainGUI() {
super();
initialize();
}
/**
* Panel initialization
*/
private void initialize() {
config = Configuration.getInstance();
setPanelIcon("/images/merge.png");
setPreferredSize(new Dimension(500,550));
setLayout(new GridBagLayout());
topPanel.setLayout(new GridBagLayout());
GridBagConstraints topConst = new GridBagConstraints();
topConst.fill = GridBagConstraints.BOTH;
topConst.ipady = 5;
topConst.weightx = 1.0;
topConst.weighty = 1.0;
topConst.gridwidth = 3;
topConst.gridheight = 2;
topConst.gridx = 0;
topConst.gridy = 0;
topPanel.add(selectionPanel, topConst);
selectionPanel.addPropertyChangeListener(this);
//END_BROWSE_FILE_CHOOSER
// OPTION_PANEL
layoutOptionPanel = new SpringLayout();
optionPanel.setLayout(layoutOptionPanel);
optionPanel.setBorder(BorderFactory.createTitledBorder(GettextResource.gettext(config.getI18nResourceBundle(),"Merge options")));
optionPanel.setMinimumSize(new Dimension(50,50));
optionPanel.setPreferredSize(new Dimension(50,60));
topConst.fill = GridBagConstraints.HORIZONTAL;
topConst.weightx = 0.0;
topConst.weighty = 0.0;
topConst.gridwidth = 3;
topConst.gridheight = 1;
topConst.gridx = 0;
topConst.gridy = 2;
topPanel.add(optionPanel, topConst);
mergeTypeCheck.setText(GettextResource.gettext(config.getI18nResourceBundle(),"PDF documents contain forms"));
mergeTypeCheck.setSelected(false);
optionPanel.add(mergeTypeCheck);
String helpText =
""+GettextResource.gettext(config.getI18nResourceBundle(),"Merge type")+"
" +
"
"+GettextResource.gettext(config.getI18nResourceBundle(),"Unchecked")+": "+GettextResource.gettext(config.getI18nResourceBundle(),"Use this merge type for standard pdf documents")+".
" +
"
"+GettextResource.gettext(config.getI18nResourceBundle(),"Checked")+": "+GettextResource.gettext(config.getI18nResourceBundle(),"Use this merge type for pdf documents containing forms")+"." +
" "+GettextResource.gettext(config.getI18nResourceBundle(),"Note")+": "+GettextResource.gettext(config.getI18nResourceBundle(),"Setting this option the documents will be completely loaded in memory")+".
"+GettextResource.gettext(config.getI18nResourceBundle(),"Browse or enter the full path to the destination output file.")+"
"+
"
"+GettextResource.gettext(config.getI18nResourceBundle(),"Check the box if you want to overwrite the output file if it already exists.")+"
"+
"
"+GettextResource.gettext(config.getI18nResourceBundle(),"Check the box if you want compressed output files.")+" "+GettextResource.gettext(config.getI18nResourceBundle(),"PDF version 1.5 or above.")+"
"+
"
"+GettextResource.gettext(config.getI18nResourceBundle(),"Set the pdf version of the ouput document.")+"
"+ "";
destinationHelpLabel = new JHelpLabel(helpTextDest, true);
destinationPanel.add(destinationHelpLabel);
//END_HELP_LABEL_DESTINATION
//RUN_BUTTON
runButton.addActionListener(new ActionListener() {
public void actionPerformed(ActionEvent e) {
if (WorkExecutor.getInstance().getRunningThreads() > 0 || selectionPanel.isAdding()){
log.info(GettextResource.gettext(config.getI18nResourceBundle(),"Please wait while all files are processed.."));
return;
}
final LinkedList args = new LinkedList();
try{
PdfSelectionTableItem[] items = selectionPanel.getTableRows();
if(items != null && items.length >= 1){
String destination = "";
//if no extension given
if ((destinationTextField.getText().length() > 0) && !(destinationTextField.getText().matches(PDF_EXTENSION_REGEXP))){
destinationTextField.setText(destinationTextField.getText()+"."+PDF_EXTENSION);
}
if(destinationTextField.getText().length()>0){
File destinationDir = new File(destinationTextField.getText());
File parent = destinationDir.getParentFile();
if(!(parent!=null && parent.exists())){
String suggestedDir = null;
if(Configuration.getInstance().getDefaultWorkingDir()!=null && Configuration.getInstance().getDefaultWorkingDir().length()>0){
suggestedDir = new File(Configuration.getInstance().getDefaultWorkingDir(), destinationDir.getName()).getAbsolutePath();
}else{
if(items!=null & items.length>0){
PdfSelectionTableItem item = items[items.length-1];
if(item!=null && item.getInputFile()!=null){
suggestedDir = new File(item.getInputFile().getParent(), destinationDir.getName()).getAbsolutePath();
}
}
}
if(suggestedDir != null){
int chosenOpt = DialogUtility.showConfirmOuputLocationDialog(getParent(),suggestedDir);
if(JOptionPane.YES_OPTION == chosenOpt){
destinationTextField.setText(suggestedDir);
}else if(JOptionPane.CANCEL_OPTION == chosenOpt){
return;
}
}
}
}
destination = destinationTextField.getText();
//check if the file already exists and the user didn't select to overwrite
File destFile = (destination!=null)? new File(destination):null;
if(destFile!=null && destFile.exists() && !overwriteCheckbox.isSelected()){
int chosenOpt = DialogUtility.askForOverwriteOutputFileDialog(getParent(),destFile.getName());
if(JOptionPane.YES_OPTION == chosenOpt){
overwriteCheckbox.setSelected(true);
}else if(JOptionPane.CANCEL_OPTION == chosenOpt){
return;
}
}
args.add("-"+ConcatParsedCommand.O_ARG);
args.add(destination);
PdfSelectionTableItem item = null;
String pageSelectionString = "";
for (int i = 0; i < items.length; i++){
item = items[i];
String pageSelection = (item.getPageSelection()!=null && item.getPageSelection().length()>0)?item.getPageSelection():ALL_STRING;
//add ":" at the end if necessary
if(!pageSelection.endsWith(":")){
pageSelection += ":";
}
Pattern p = Pattern.compile(ConcatCmdValidator.SELECTION_REGEXP, Pattern.CASE_INSENSITIVE);
if (!(p.matcher(pageSelection).matches())) {
DialogUtility.errorValidatingBounds(getParent(), pageSelection);
return;
} else {
args.add("-" + ConcatParsedCommand.F_ARG);
String f = item.getInputFile().getAbsolutePath();
if ((item.getPassword()) != null && (item.getPassword()).length() > 0) {
log.debug(GettextResource.gettext(config.getI18nResourceBundle(),"Found a password for input file."));
f += ":" + item.getPassword();
}
args.add(f);
pageSelectionString += pageSelection;
}
}
args.add("-"+ConcatParsedCommand.U_ARG);
args.add(pageSelectionString);
if (overwriteCheckbox.isSelected()) args.add("-"+ConcatParsedCommand.OVERWRITE_ARG);
if (outputCompressedCheck.isSelected()) args.add("-"+ConcatParsedCommand.COMPRESSED_ARG);
if (mergeTypeCheck.isSelected()) args.add("-"+ConcatParsedCommand.COPYFIELDS_ARG);
args.add("-"+ConcatParsedCommand.PDFVERSION_ARG);
args.add(((StringItem)versionCombo.getSelectedItem()).getId());
args.add (AbstractParsedCommand.COMMAND_CONCAT);
final String[] myStringArray = (String[])args.toArray(new String[args.size()]);
WorkExecutor.getInstance().execute(new WorkThread(myStringArray));
}else{
JOptionPane.showMessageDialog(getParent(),
GettextResource.gettext(config.getI18nResourceBundle(),"Please select at least one pdf document."),
GettextResource.gettext(config.getI18nResourceBundle(),"Warning"),
JOptionPane.WARNING_MESSAGE);
}
}catch(Exception ex){
log.error(GettextResource.gettext(config.getI18nResourceBundle(),"Error: "), ex);
SoundPlayer.getInstance().playErrorSound();
}
}
});
runButton.setToolTipText(GettextResource.gettext(config.getI18nResourceBundle(),"Execute pdf merge"));
runButton.setSize(new Dimension(88,25));
c.fill = GridBagConstraints.NONE;
c.ipadx = 5;
c.weightx = 0.0;
c.weighty = 0.0;
c.anchor = GridBagConstraints.LAST_LINE_END;
c.gridwidth = 1;
c.gridx = 2;
c.gridy = 2;
c.insets = new Insets(10,10,10,10);
add(runButton, c);
//END_RUN_BUTTON
//KEY_LISTENER
runButton.addKeyListener(runEnterKeyListener);
browseDestButton.addKeyListener(browseEnterKeyListener);
destinationTextField.addKeyListener(runEnterKeyListener);
//LAYOUT
selectionPanel.addPopupMenuItem(new JSaveListAsXmlMenuItem(selectionPanel));
setLayout();
//END_LAYOUT
}
/**
* Set plugin layout for each component
*
*/
private void setLayout(){
layoutOptionPanel.putConstraint(SpringLayout.SOUTH, mergeTypeCheck, 30, SpringLayout.NORTH, optionPanel);
layoutOptionPanel.putConstraint(SpringLayout.EAST, mergeTypeCheck, -40, SpringLayout.EAST, optionPanel);
layoutOptionPanel.putConstraint(SpringLayout.NORTH, mergeTypeCheck, 0, SpringLayout.NORTH, optionPanel);
layoutOptionPanel.putConstraint(SpringLayout.WEST, mergeTypeCheck, 5, SpringLayout.WEST, optionPanel);
layoutOptionPanel.putConstraint(SpringLayout.SOUTH, mergeTypeHelpLabel, -1, SpringLayout.SOUTH, optionPanel);
layoutOptionPanel.putConstraint(SpringLayout.EAST, mergeTypeHelpLabel, -1, SpringLayout.EAST, optionPanel);
layoutDestinationPanel.putConstraint(SpringLayout.EAST, destinationTextField, -105, SpringLayout.EAST, destinationPanel);
layoutDestinationPanel.putConstraint(SpringLayout.NORTH, destinationTextField, 10, SpringLayout.NORTH, destinationPanel);
layoutDestinationPanel.putConstraint(SpringLayout.SOUTH, destinationTextField, 30, SpringLayout.NORTH, destinationPanel);
layoutDestinationPanel.putConstraint(SpringLayout.WEST, destinationTextField, 5, SpringLayout.WEST, destinationPanel);
layoutDestinationPanel.putConstraint(SpringLayout.SOUTH, overwriteCheckbox, 17, SpringLayout.NORTH, overwriteCheckbox);
layoutDestinationPanel.putConstraint(SpringLayout.NORTH, overwriteCheckbox, 5, SpringLayout.SOUTH, destinationTextField);
layoutDestinationPanel.putConstraint(SpringLayout.WEST, overwriteCheckbox, 0, SpringLayout.WEST, destinationTextField);
layoutDestinationPanel.putConstraint(SpringLayout.SOUTH, outputCompressedCheck, 17, SpringLayout.NORTH, outputCompressedCheck);
layoutDestinationPanel.putConstraint(SpringLayout.NORTH, outputCompressedCheck, 5, SpringLayout.SOUTH, overwriteCheckbox);
layoutDestinationPanel.putConstraint(SpringLayout.WEST, outputCompressedCheck, 0, SpringLayout.WEST, destinationTextField);
layoutDestinationPanel.putConstraint(SpringLayout.SOUTH, outputVersionLabel, 17, SpringLayout.NORTH, outputVersionLabel);
layoutDestinationPanel.putConstraint(SpringLayout.NORTH, outputVersionLabel, 5, SpringLayout.SOUTH, outputCompressedCheck);
layoutDestinationPanel.putConstraint(SpringLayout.WEST, outputVersionLabel, 0, SpringLayout.WEST, destinationTextField);
layoutDestinationPanel.putConstraint(SpringLayout.SOUTH, versionCombo, 0, SpringLayout.SOUTH, outputVersionLabel);
layoutDestinationPanel.putConstraint(SpringLayout.NORTH, versionCombo, 0, SpringLayout.NORTH, outputVersionLabel);
layoutDestinationPanel.putConstraint(SpringLayout.WEST, versionCombo, 2, SpringLayout.EAST, outputVersionLabel);
layoutDestinationPanel.putConstraint(SpringLayout.SOUTH, browseDestButton, 25, SpringLayout.NORTH, browseDestButton);
layoutDestinationPanel.putConstraint(SpringLayout.EAST, browseDestButton, -5, SpringLayout.EAST, destinationPanel);
layoutDestinationPanel.putConstraint(SpringLayout.NORTH, browseDestButton, 0, SpringLayout.NORTH, destinationTextField);
layoutDestinationPanel.putConstraint(SpringLayout.WEST, browseDestButton, -93, SpringLayout.EAST, destinationPanel);
layoutDestinationPanel.putConstraint(SpringLayout.SOUTH, destinationHelpLabel, -1, SpringLayout.SOUTH, destinationPanel);
layoutDestinationPanel.putConstraint(SpringLayout.EAST, destinationHelpLabel, -1, SpringLayout.EAST, destinationPanel);
}
/**
* @return the Plugin author
*/
public String getPluginAuthor(){
return PLUGIN_AUTHOR;
}
/**
* @return the Plugin name
*/
public String getPluginName(){
return GettextResource.gettext(config.getI18nResourceBundle(),"Merge/Extract");
}
/**
* @return the Plugin version
*/
public String getVersion(){
return PLUGIN_VERSION;
}
/**
* @return the FocusTraversalPolicy associated with the plugin
*/
public FocusTraversalPolicy getFocusPolicy(){
return (FocusTraversalPolicy)mergeFocusPolicy;
}
public Node getJobNode(Node arg0, boolean savePasswords) throws SaveJobException {
try{
if (arg0 != null){
Element filelist = ((Element)arg0).addElement("filelist");
PdfSelectionTableItem[] items = selectionPanel.getTableRows();
for (int i = 0; i < items.length; i++){
Element fileNode = ((Element)filelist).addElement("file");
fileNode.addAttribute("name",items[i].getInputFile().getAbsolutePath());
fileNode.addAttribute("pageselection",(items[i].getPageSelection()!=null)?items[i].getPageSelection():ALL_STRING);
if(savePasswords){
fileNode.addAttribute("password",items[i].getPassword());
}
}
Element fileDestination = ((Element)arg0).addElement("destination");
fileDestination.addAttribute("value", destinationTextField.getText());
Element fileOverwrite = ((Element)arg0).addElement("overwrite");
fileOverwrite.addAttribute("value", overwriteCheckbox.isSelected()?TRUE:FALSE);
Element mergeType = ((Element)arg0).addElement("merge_type");
mergeType.addAttribute("value", mergeTypeCheck.isSelected()?TRUE:FALSE);
Element fileCompress = ((Element)arg0).addElement("compressed");
fileCompress.addAttribute("value", outputCompressedCheck.isSelected()?TRUE:FALSE);
Element pdfVersion = ((Element)arg0).addElement("pdfversion");
pdfVersion.addAttribute("value", ((StringItem)versionCombo.getSelectedItem()).getId());
}
return arg0;
}
catch (Exception ex){
throw new SaveJobException(ex);
}
}
public void loadJobNode(Node arg0) throws LoadJobException {
if(arg0 != null){
try{
resetPanel();
Node fileDestination = (Node) arg0.selectSingleNode("destination/@value");
if (fileDestination != null){
destinationTextField.setText(fileDestination.getText());
}
Node fileOverwrite = (Node) arg0.selectSingleNode("overwrite/@value");
if (fileOverwrite != null){
overwriteCheckbox.setSelected(TRUE.equals(fileOverwrite.getText()));
}
Node mergeType = (Node) arg0.selectSingleNode("merge_type/@value");
if (mergeType != null){
mergeTypeCheck.setSelected(TRUE.equals(mergeType.getText()));
}
List fileList = arg0.selectNodes("filelist/file");
for (int i = 0; fileList != null && i < fileList.size(); i++) {
Node fileNode = (Node) fileList.get(i);
if(fileNode != null){
Node fileName = (Node) fileNode.selectSingleNode("@name");
if (fileName != null && fileName.getText().length()>0){
Node pageSelection = (Node) fileNode.selectSingleNode("@pageselection");
Node filePwd = (Node) fileNode.selectSingleNode("@password");
selectionPanel.getLoader().addFile(new File(fileName.getText()), (filePwd!=null)?filePwd.getText():null, (pageSelection!=null)?pageSelection.getText():null);
}
}
}
Node fileCompressed = (Node) arg0.selectSingleNode("compressed/@value");
if (fileCompressed != null && TRUE.equals(fileCompressed.getText())){
outputCompressedCheck.doClick();
}
Node pdfVersion = (Node) arg0.selectSingleNode("pdfversion/@value");
if (pdfVersion != null){
for (int i = 0; i
jcmdline
pdfsam-1.1.4/jcmdline/apidocs/ 0000755 0001750 0001750 00000000000 11225360204 016127 5 ustar twerner twerner pdfsam-1.1.4/jcmdline/src/ 0000755 0001750 0001750 00000000000 10711620554 015302 5 ustar twerner twerner pdfsam-1.1.4/jcmdline/src/java/ 0000755 0001750 0001750 00000000000 10711620572 016223 5 ustar twerner twerner pdfsam-1.1.4/jcmdline/src/java/jcmdline/ 0000755 0001750 0001750 00000000000 10711667234 020016 5 ustar twerner twerner pdfsam-1.1.4/jcmdline/src/java/jcmdline/CmdLineHandler.java 0000644 0001750 0001750 00000022743 10201471366 023473 0 ustar twerner twerner /*
* CmdLineHandler.java
*
* Classes:
* public CmdLineHandler
*
* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (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.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is the Java jcmdline (command line management) package.
*
* The Initial Developer of the Original Code is Lynne Lawrence.
*
* Portions created by the Initial Developer are Copyright (C) 2002
* the Initial Developer. All Rights Reserved.
*
* Contributor(s): Lynne Lawrence
*
* ***** END LICENSE BLOCK *****
*/
package jcmdline;
import java.util.Collection;
import java.util.List;
/**
* Interface that describes the API for a command line handler. A command
* line handler is an object that is passed information concerning the
* required structure of command's command line and then can be used to
* parse the command line, taking action as configured.
*
* Information on using CmdLineHandlers can be found in the jcmdline
* User Guide.
*
* @author Lynne Lawrence
* @version jcmdline Rel. @VERSION@ $Id: CmdLineHandler.java,v 1.2 2002/12/07 14:22:06 lglawrence Exp $
* @see Parameter
* @see CmdLineParser
* @see UsageFormatter
*/
public interface CmdLineHandler {
/**
* Sets a flag indicating that the program should exit in the case of
* a parse error (after displaying the usage and an error message) -
* defaults to true.
*
* @param val true (the default) if the
* parse method should call System.exit() in
* case of a parse error, false if
* parse() should return to the user
* for error processing.
* @see #parse(String[]) parse()
*/
public void setDieOnParseError(boolean val) ;
/**
* Gets a flag indicating that the program should exit in the case of
* a parse error (after displaying the usage and an error message).
*
* @return true (the default) if the
* parse method should call System.exit() in
* case of a parse error, false if
* parse() should return to the user
* for error processing.
* @see #parse(String[]) parse()
*/
public boolean getDieOnParseError() ;
/**
* parse the specified command line arguments
*
* @param clargs command line arguments passed to the main() method
* of CmdLineHandler's creating class.
* @return This method will exit, rather than returning, if one of the
* following conditions is met:
*
*
-h, or
* -h!, or
* -?,
* are amongst the command line arguments - the
* appropriate information is displayed on stdout,
* and the program exits with status 0.
*
OR, dieOnParseError is set to true AND:
*
*
a command line argument is incorrectly specified -
* an error message is displayed and the program
* exits with status 1.
*
a required command line argument is missing - an error
* message is displayed and the program exits with status 1.
*
*
* If dieOnParseError is set to false,
* this method will return true if there are no parse errors. If
* there are parse errors, falseis returned and
* an appropriate error message may be obtained by calling
* {@link #getParseError()}.
*/
public boolean parse(String[] clargs) ;
/**
* Sets the parser to be used to parse the command line.
*
* @param parser the parser to be used to parse the command line
* @see #getParser()
*/
public void setParser(CmdLineParser parser) ;
/**
* Gets the parser to be used to parse the command line.
*
* @return the parser to be used to parse the command line
* @see #setParser(CmdLineParser) setParser()
*/
public CmdLineParser getParser() ;
/**
* sets the value of the arguments (what is left on the command line after
* all options, and their parameters, have been processed) associated
* with the command
*
* @param args A Collection of {@link Parameter} objects. This may
* be null if the command accepts no command line
* arguments.
*/
public void setArgs(Parameter[] args) ;
/**
* Adds a command line arguement.
*
* @param arg the new command line argument
* @throws IllegalArgumentException if arg
* is null.
*/
public void addArg(Parameter arg) ;
/**
* gets the value of the arguments (what is left on the command line after
* all options, and their parameters, have been processed) associated
* with the command
*
* @return the command's options
*/
public List getArgs() ;
/**
* gets the argument specified by tag
*
* @param tag identifies the argument to be returned
* @return The argument associated with tag.
* If no matching argument is found, null is returned.
*/
public Parameter getArg(String tag) ;
/**
* Sets the value of the options associated with the command
*
* @param options A Collection of {@link Parameter} objects. This may
* be null if the command accepts no command line
* options.
*/
public void setOptions(Parameter[] options) ;
/**
* Adds a command line option.
*
* @param opt the new command line option
* @throws IllegalArgumentException if the tag associated with
* opt has already been defined for an
* option.
*/
public void addOption(Parameter opt) ;
/**
* gets the value of the options associated with the command
*
* @return the command's options
*/
public Collection getOptions() ;
/**
* gets the option specified by tag
*
* @param tag identifies the option to be returned
* @return the option associated with tag
*/
public Parameter getOption(String tag) ;
/**
* sets a description of the command's purpose
*
* @param cmdDesc a short description of the command's purpose
* @throws IllegalArgumentException if cmdDesc
* is null or of 0 length.
*/
public void setCmdDesc(String cmdDesc) ;
/**
* gets a description of the command's purpose
*
* @return the command's description
*/
public String getCmdDesc() ;
/**
* sets the value of the command name associated with this CmdLineHandler
*
* @param cmdName the name of the command associated with this
* CmdLineHandler
* @throws IllegalArgumentException if cmdName is null,
* or of 0 length
*/
public void setCmdName(String cmdName) ;
/**
* gets the value of the command name associated with this CmdLineHandler
*
* @return the command name
*/
public String getCmdName() ;
/**
* Gets the usage statement associated with the command.
*
* @param hidden indicates whether hidden options are to be included
* in the usage.
* @return the usage statement associated with the command
*/
public String getUsage(boolean hidden) ;
/**
* Sets the error message from the last call to parse().
*
* @param parseError the error message from the last call to parse()
* @see #getParseError()
*/
public void setParseError(String parseError) ;
/**
* Gets the error message from the last call to parse().
*
* @return the error message from the last call to parse()
* @see #setParseError(String) setParseError()
*/
public String getParseError() ;
/**
* Prints the usage, followed by the specified error message, to stderr
* and exits the program with exit status = 1. The error message will
* be prefaced with 'ERROR: '.
*
* @param errMsg the error message
* @return Doesn't return - exits the program with exit status
* of 1.
*/
public void exitUsageError(String errMsg) ;
}
pdfsam-1.1.4/jcmdline/src/java/jcmdline/BasicCmdLineHandler.java 0000644 0001750 0001750 00000060051 10722536316 024434 0 ustar twerner twerner /*
* BasicCmdLineHandler.java
*
* Classes:
* public BasicCmdLineHandler
*
* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (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.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is the Java jcmdline (command line management) package.
*
* The Initial Developer of the Original Code is Lynne Lawrence.
*
* Portions created by the Initial Developer are Copyright (C) 2002
* the Initial Developer. All Rights Reserved.
*
* Contributor(s): Lynne Lawrence
*
* ***** END LICENSE BLOCK *****
*/
package jcmdline;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
/**
* Used to define, parse, and validate the parameters associated with an
* executable's command line.
*
* Objects of this class use a {@link CmdLineParser} to do the actual
* parsing of the command line. By default, this class uses a
* {@link PosixCmdLineParser}.
*
* The following semantics are used throughout the documentation for this
* class. A command line parameter refers to either a command line
* option, or a command line argument.
*
* A command line option is identified by a tag and may or
* not have an associated value. For instance, in the following posix-type
* option, "outfile" is the tag and "/tmp/myoutfile" is the
* value:
*
* --outfile /tmp/myoutfile
*
*
Command line
* arguments are what are left on the command line after all
* options have been processed. For example, again using a posix style
* command line, "filename1" and "filename2" would be the arguments:
*
* -e 's/red/blue/' filename1 filename2
*
*
* Parameters may be designated as hidden.
* Hidden parameters are those that can be specified,
* but whose documentation
* is not displayed to the user when a normal usage is printed.
*
* This class is used as in the following example of a 'cat' facsimile in java:
*
* public class Concat {
* static FileParam outfile = new FileParam(
* "out",
* "a file to receive the concatenated files (default is stdout)");
* static BooleanParam delete = new BooleanParam(
* "delete",
* "specifies that all of the original files are to be deleted");
* static FileParam infiles = new FileParam(
* "filename",
* "files to be concatenated",
* FileParam.IS_FILE & FileParam.IS_READABLE,
* FileParam.REQUIRED,
* FileParam.MULTI_VALUED);
*
* public static void main(String[] args) {
* outfile.setOptionLabel("outfile");
* BasicCmdLineHandler clp = new BasicCmdLineHandler(
* "Concat", "concatenates the specified files",
* new Parameter[] { outfile, delete },
* new Parameter[] { infiles });
* clp.parse(args);
*
* if (outfile.isSet()) {
* ....
* } else {
* ...
* }
* for (Iterator itr = infiles.getFiles().iterator(); itr.hasNext(); ) {
* ...
* }
* if (delete.isTrue()) {
* ...
* }
* }
* }
*
*
*
* This class implements no options on its own. It it typically used in
* conjunction with one or more of the {@link AbstractHandlerDecorator}
* classes that provide some useful options.
*
* Post Processing Command Line Parameters
*
* It may be the case that none of the supplied Parameter types fully
* accomodates a program's needs. For instance, a program may require
* a filename option that is an html filename, ending with '.html'. In
* this case, the programmer has the options of creating their own
* Parameter subclass, or post-processing the returned FileParam parameter
* and generating their own error message. The
* {@link #exitUsageError(String) exitUsageError()} method is
* provided so that programs that post-process parameters can take
* the same exit as would be taken for "normal" parameter processing
* failures. For instance, in the case just described, the following
* code could be used to exit the program if the specified file did not
* end with '.html' (myfile
* being a FileParam object, and cl
* being the BasicCmdLineHandler object):
*
* cl.parse(args);
* if (! myfile.getFile().getPath().endsWith(".html")) {
* cl.exitUsageError("Filename specified for '" +
* myfile.getTag() + "' must end with '.html'");
* }
*
*
* @author Lynne Lawrence
* @version jcmdline Rel. @VERSION@ $Id: BasicCmdLineHandler.java,v 1.4 2005/02/06 13:19:19 lglawrence Exp $
* @see Parameter
* @see CmdLineParser
*/
public class BasicCmdLineHandler implements CmdLineHandler {
/**
* the name of the command whose command line is to be parsed
*/
private String cmdName;
/**
* a short description of the command's purpose
*/
private String cmdDesc;
/**
* the options associated with the command
*/
private HashMap options = new HashMap();
/**
* the arguments (after the options have been processed) associated
* with the command
*/
private ArrayList args = new ArrayList();
/**
* the parser to be used to parse the command line
* @see #setParser(CmdLineParser) setParser()
* @see #getParser()
*/
private CmdLineParser parser;
/**
* indicates that the command usage should be displayed, and System.exit(1)
* called in the case of a parse error.
* @see #setDieOnParseError(boolean) setDieOnParseError()
*/
private boolean dieOnParseError = true;
/**
* the error message from the last call to parse()
* @see #setParseError(String) setParseError()
* @see #getParseError()
*/
private String parseError;
/**
* constructor
*
* @param cmdName the name of the command
* @param cmdDesc a short description of the command
* @param options a collection of Parameter objects, describing the
* command's command-line options
* @param args a collection of Parameter objects, describing the
* command's command-line arguments (what is left on
* the command line after all options and their
* parameters have been processed)
* @param parser a CmdLineParser to be used to parse the command line
* @throws IllegalArgumentException if any of the
* parameters are not correctly specified.
* @see #setCmdName(String) setCmdName()
* @see #setCmdDesc(String) setCmdDesc()
* @see #setOptions(Parameter[]) setOptions()
* @see #setArgs(Parameter[]) setArgs()
* @see #setParser(CmdLineParser) setParser()
*/
public BasicCmdLineHandler (String cmdName,
String cmdDesc,
Parameter[] options,
Parameter[] args,
CmdLineParser parser) {
setCmdName(cmdName);
setCmdDesc(cmdDesc);
setOptions(options);
setArgs(args);
setParser(parser);
}
/**
* constructor - uses the PosixCmdLineParser to parse the command line
*
* @param cmdName the name of the command
* @param cmdDesc a short description of the command
* @param options a collection of Parameter objects, describing the
* command's command-line options
* @param args a collection of Parameter objects, describing the
* command's command-line arguments (what is left on
* the command line after all options and their
* parameters have been processed)
* @throws IllegalArgumentException if any of the
* parameters are not correctly specified.
* @see #setCmdName(String) setCmdName()
* @see #setCmdDesc(String) setCmdDesc()
* @see #setOptions(Parameter[]) setOptions()
* @see #setArgs(Parameter[]) setArgs()
* @see PosixCmdLineParser
*/
public BasicCmdLineHandler (String cmdName,
String cmdDesc,
Parameter[] options,
Parameter[] args) {
this(cmdName, cmdDesc, options, args, new PosixCmdLineParser());
}
/**
* constructor - uses the PosixCmdLineParser to parse the command line
*
* @param cmdName the name of the command creating this
* BasicCmdLineHandler
* @param cmdDesc a short description of the command's purpose
* @param options a collection of Parameter objects, describing the
* command's command-line options
* @param args a collection of Parameter objects, describing the
* command's command-line arguments (what is left on
* the command line after all options and their
* parameters have been processed)
* @throws IllegalArgumentException if any of the
* parameters are not correctly specified.
* @see #setCmdName(String) setCmdName()
* @see #setCmdDesc(String) setCmdDesc()
* @see #setOptions(Parameter[]) setOptions()
* @see PosixCmdLineParser
*/
public BasicCmdLineHandler (String cmdName,
String cmdDesc,
Collection options,
Collection args) {
this(cmdName,
cmdDesc,
(Parameter[]) options.toArray(new Parameter[0]),
(Parameter[]) args.toArray(new Parameter[0]));
}
/**
* Parse the specified command line arguments. This method will fail if:
*
*
the CmdLineParser is unable to parse the command line
* parameters into the required options and arguments.
*
a required Parameter has not been set by the parser.
*
*
* @param clargs command line arguments passed to the main() method
* of BasicCmdLineHandler's creating class.
* @return If dieOnParseError is set to false,
* this method will return true if there are no parse errors. If
* there are parse errors, falseis returned and
* an appropriate error message may be obtained by calling
* {@link #getParseError()}.
*
* If dieOnParseError is set to true
* and the method fails, the program will exit with exit code 1
* after printing the usage to stderr.
*/
public boolean parse(String[] clargs) {
if (clargs == null) {
clargs = new String[] {};
}
try {
parser.parse(clargs, options, args);
if (!canSkipRequiredCheck()) {
checkForRequired();
}
} catch (CmdLineException e) {
if (dieOnParseError) {
exitUsageError(e.getMessage());
} else {
parseError = e.getMessage();
return false;
}
}
return true;
}
/**
* Sets the parser to be used to parse the command line.
*
* @param parser the parser to be used to parse the command line
* @see #getParser()
*/
public void setParser(CmdLineParser parser) {
this.parser = parser;
}
/**
* Gets the parser to be used to parse the command line.
*
* @return the parser to be used to parse the command line
* @see #setParser(CmdLineParser) setParser()
*/
public CmdLineParser getParser() {
return parser;
}
/**
* Sets a flag indicating that the program should exit in the case of
* a parse error (after displaying the usage and an error message) -
* defaults to true.
*
* @param val true (the default) if the
* parse method should call System.exit() in
* case of a parse error, false if
* parse() should return to the user
* for error processing.
* @see #parse(String[]) parse()
*/
public void setDieOnParseError(boolean val) {
dieOnParseError = val;
}
/**
* Gets a flag indicating that the program should exit in the case of
* a parse error (after displaying the usage and an error message).
*
* @return true (the default) if the
* parse method should call System.exit() in
* case of a parse error, false if
* parse() should return to the user
* for error processing.
* @see #parse(String[]) parse()
*/
public boolean getDieOnParseError() {
return dieOnParseError;
}
/**
* Prints the usage, followed by the specified error message, to stderr
* and exits the program with exit status = 1. The error message will
* be prefaced with 'ERROR: '.
*
* @param errMsg the error message
* @return Doesn't return - exits the program with exit status
* of 1.
*/
public void exitUsageError(String errMsg) {
System.err.println(getUsage(false));
System.err.println(
"\n" + parser.getUsageFormatter().formatErrorMsg(errMsg));
quitProgram(1);
}
/**
* sets the value of the arguments (what is left on the command line after
* all options, and their parameters, have been processed) associated
* with the command
*
* @param args A Collection of {@link Parameter} objects. This may
* be null if the command accepts no command line
* arguments.
*/
public void setArgs(Parameter[] args) {
this.args.clear();
if (args != null) {
for (int i = 0; i < args.length; i++) {
addArg(args[i]);
}
}
}
/**
* Adds a command line arguement. Command line arguments must be added
* in the order that they will be specified on the command line.
*
* @param arg the new command line argument
* @throws IllegalArgumentException if:
*
*
arg is null
*
the previously added argument was multi-valued (only
* the last argument can be multi-valued)
*
arg is a required argument but the
* previous argument was optional
*
*/
public void addArg(Parameter arg) {
if (arg == null) {
throw new IllegalArgumentException(Strings.get(
"BasicCmdLineHandler.nullArgNotAllowed"));
}
if (args.size() > 0) {
Parameter lastArg = (Parameter) args.get(args.size() - 1);
if (lastArg.isMultiValued()) {
throw new IllegalArgumentException(Strings.get(
"BasicCmdLineHandler.multiValueArgNotLast",
new Object[] { lastArg.getTag() }));
}
if (! arg.isOptional() && lastArg.isOptional()) {
throw new IllegalArgumentException(Strings.get(
"BasicCmdLineHandler.requiredArgAfterOptArg",
new Object[] { arg.getTag(), lastArg.getTag() }));
}
}
args.add(arg);
}
/**
* gets the value of the arguments (what is left on the command line after
* all options, and their parameters, have been processed) associated
* with the command
*
* @return the command's options
*/
public List getArgs() {
return args;
}
/**
* gets the argument specified by tag
*
* @param tag identifies the argument to be returned
* @return The argument associated with tag.
* If no matching argument is found, null is returned.
*/
public Parameter getArg(String tag) {
Parameter arg;
for (Iterator itr = args.iterator(); itr.hasNext(); ) {
arg = (Parameter) itr.next();
if (arg.getTag().equals(tag)) {
return arg;
}
}
return null;
}
/**
* Sets the value of the options associated with the command
*
* @param options A Collection of {@link Parameter} objects. This may
* be null if the command accepts no command line
* options.
*/
public void setOptions(Parameter[] options) {
this.options.clear();
if (options != null) {
for (int i = 0; i < options.length; i++) {
addOption(options[i]);
}
}
}
/**
* Adds a command line option.
*
* @param opt the new command line option
* @throws NullPointerException if opt is null.
* @throws IllegalArgumentException if an option with the
* same tag has already been added.
*/
public void addOption(Parameter opt) {
if (opt == null) {
throw new NullPointerException();
}
if (options.containsKey(opt.getTag())) {
throw new IllegalArgumentException(Strings.get(
"BasicCmdLineHandler.duplicateOption",
new Object[] { opt.getTag() }));
}
options.put(opt.getTag().toLowerCase(), opt);
}
/**
* gets the value of the options associated with the command
*
* @return the command's options
*/
public Collection getOptions() {
return options.values();
}
/**
* gets the option specified by tag
*
* @param tag identifies the option to be returned
* @return the option associated with tag
*/
public Parameter getOption(String tag) {
return (Parameter) options.get(tag);
}
/**
* sets a description of the command's purpose
*
* @param cmdDesc a short description of the command's purpose
* @throws IllegalArgumentException if cmdDesc
* is null or of 0 length.
*/
public void setCmdDesc(String cmdDesc) {
if (cmdDesc == null || cmdDesc.length() <= 0) {
throw new IllegalArgumentException(Strings.get(
"BasicCmdLineHandler.cmdDescTooShort",
new Object[] { cmdDesc }));
}
this.cmdDesc = cmdDesc;
}
/**
* gets a description of the command's purpose
*
* @return the command's description
*/
public String getCmdDesc() {
return cmdDesc;
}
/**
* sets the value of the command name associated with this BasicCmdLineHandler
*
* @param cmdName the name of the command associated with this
* BasicCmdLineHandler
* @throws IllegalArgumentException if cmdName is null,
* or of 0 length
*/
public void setCmdName(String cmdName) {
if (cmdName == null && cmdName.length() <= 0) {
throw new IllegalArgumentException(Strings.get(
"BasicCmdLineHandler.cmdNameTooShort",
new Object[] { cmdName }));
}
this.cmdName = cmdName;
}
/**
* gets the value of the command name associated with this
* BasicCmdLineHandler
*
* @return the command name
*/
public String getCmdName() {
return cmdName;
}
/**
* Gets the usage statement associated with the command.
*
* @param hidden indicates whether hidden options are to be included
* in the usage.
* @return the usage statement associated with the command
*/
public String getUsage(boolean hidden) {
return parser.getUsageFormatter()
.formatUsage(cmdName, cmdDesc, options, args, hidden);
}
/**
* Sets the error message from the last call to parse().
*
* @param parseError the error message from the last call to parse()
* @see #getParseError()
*/
public void setParseError(String parseError) {
this.parseError = parseError;
}
/**
* Gets the error message from the last call to parse().
*
* @return the error message from the last call to parse()
* @see #setParseError(String) setParseError()
*/
public String getParseError() {
return parseError;
}
/**
* Indicates whether the check for required Parameters can be skipped
* due to a Parameter with flag ignoreRequired = true
* having been set.
*
* @return true if the check for required parameters may be
* skipped
*/
private boolean canSkipRequiredCheck() {
Parameter p;
for (Iterator itr = options.values().iterator(); itr.hasNext(); ) {
p = (Parameter) itr.next();
if (p.getIgnoreRequired() && p.isSet()) {
return true;
}
}
for (Iterator itr = args.iterator(); itr.hasNext(); ) {
p = (Parameter)itr.next();
if (p.getIgnoreRequired() && p.isSet()) {
return true;
}
}
return false;
}
/**
* Verifies that all required options and arguments have been specified.
*
* @throws CmdLineException if a required option or argument is not set.
*/
private void checkForRequired() throws CmdLineException {
Parameter p;
for (Iterator itr = options.values().iterator(); itr.hasNext(); ) {
p = (Parameter) itr.next();
if (!p.isOptional() && !p.isSet()) {
throw new CmdLineException(Strings.get(
"BasicCmdLineHandler.missingRequiredOpt",
new Object[] { p.getTag() }));
}
}
for (Iterator itr = args.iterator(); itr.hasNext(); ) {
p = (Parameter) itr.next();
if (!p.isOptional() && !p.isSet()) {
throw new CmdLineException(Strings.get(
"BasicCmdLineHandler.missingRequiredArg",
new Object[] { p.getTag() }));
}
}
}
/**
* Exits the program with the specified exit status.
*
* @param exitStatus the program's exit status
* @return this method never returns - the program is
* terminated
*/
private void quitProgram(int exitStatus) {
System.exit(exitStatus);
}
}
pdfsam-1.1.4/jcmdline/src/java/jcmdline/AbstractHandlerDecorator.java 0000644 0001750 0001750 00000042327 10201471366 025566 0 ustar twerner twerner /*
* AbstractHandlerDecorator.java
*
* Classes:
* public AbstractHandlerDecorator
*
* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (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.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is the Java jcmdline (command line management) package.
*
* The Initial Developer of the Original Code is Lynne Lawrence.
*
* Portions created by the Initial Developer are Copyright (C) 2002
* the Initial Developer. All Rights Reserved.
*
* Contributor(s): Lynne Lawrence
*
* ***** END LICENSE BLOCK *****
*/
package jcmdline;
import java.util.Collection;
import java.util.List;
/**
* An abstract class implementing the Decorator design pattern for
* decoration of CmdLineHandler subclasses. This
* class implements all methods of the CmdLineHandler interface by
* delegating them to a contained instance of CmdLineHandler.
* The intended use for this class is specification and implementation of
* a command option that can be reused, and can be used in series with
* others of the same ilk. More information on CmdLineHandlers
* and decorator classes can be found in the
*
* jcmdline User Guide.
*
* Subclassing this Class
*
* In order to subclass this class, do the following:
*
*
With regard to the subclass constructor(s):
*
*
All constructors should accept a CmdLineHandler
* argument or create a CmdLineHandler to which
* most method calls will be delegated.
*
They should include a call to this class's
* constructor, passing their contained CmdLineHandler
* along as an argument (super(handler)) as
* the first line of the constructor.
*
In the constructor of the subclass, call setCustomOptions,
* specifying the options supported by the subclass. This ensures
* that the options are added to the contained handler, and that
* they will be restored should setOptions() be called on the
* contained handler.
*
*
Implement the processParsedOptions() method. This method will be
* called after the command line has been parsed by the contained
* handler. It is in this method that a subclass should do its
* option processing.
*
* An example of a subclass follows (note that, but for the lack of additional
* constructors, this is basically how the {@link VersionCmdLineHandler}
* is implemented).
*
* public class VersionCmdLineHandler
* extends AbstractHandlerDecorator {
*
* private BooleanParam versionOpt;
* private String version;
*
* public MyCmdLineHandler (String version,
* CmdLineHandler handler) {
* super(handler);
* if (version == null || version.length() == 0) {
* throw new IllegalArgumentException(
* "version must be specified");
* }
* this.version = version;
* versionOpt = new BooleanParam(
* Strings.get("version"),
* Strings.get("displays the version and exits"));
* versionOpt.setIgnoreRequired(true);
* setCustomOptions(new Parameter[] { versionOpt });
* }
*
* protected boolean processParsedOptions(boolean parseOk) {
* if (parseOk) {
* if (versionOpt.isTrue()) {
* System.out.println(version);
* System.exit(0);
* }
* }
* return parseOk;
* }
* }
*
*
* A Note on Option Processing
*
* CmdLineHandler decorator classes are particularly useful for options
* that perform a task and call System.exit(), such as -help or
* -version options. Options such as these should have the
* ignoreRequired attribute set to true. If not,
* and the command has required parameters, the option will never
* be accepted unless the required parameters are also specified.
*
* Notes on the {@link #processParsedOptions(boolean) processParsedOptions()}
* method
*
* The following should be kept in mind when coding the
* processParsedOptions() method:
*
*
This method may never be reached. If the dieOnParseError
* option is set true for the contained CmdLineHandler
* (which it is by default), a parse error will cause the program
* to exit before calling any processParsedOptions()
* methods.
*
If this method post-processes its option value and finds it to
* be in error, it should either call {@link #exitUsageError(String)
* exitUsageError()} or return false, as appropriate based on
* the value returned by {@link #getDieOnParseError()}. For example:
*
* if ((errorMsg = postProcess(myOpt.getValue()) != null) {
* // oops - have an error condition
* if (getDieOnParseError()) {
* exitUsageError(errorMsg);
* } else {
* return false;
* }
* }
*
*
If this method does not call System.exit() or return
* its own error, it should
* always return the parse error that was passed to it.
*
*
* @author Lynne Lawrence
* @version jcmdline Rel. @VERSION@ $Id: AbstractHandlerDecorator.java,v 1.2 2002/12/07 14:22:06 lglawrence Exp $
*/
public abstract class AbstractHandlerDecorator implements CmdLineHandler {
/**
* the instance of CmdLineHandler this class decorates.
*/
private CmdLineHandler handler;
/**
* options specific to a subclass
* @see #setCustomOptions(Parameter[]) setCustomOptions()
* @see #getCustomOptions()
*/
private Parameter[] customOptions;
/**
* constructor
*
* @param handler the CmdLineHandler to which most methods will be
* delegated
* @param customOptions the custom options implemented by the subclass
*/
protected AbstractHandlerDecorator(CmdLineHandler handler) {
this.handler = handler;
}
/**
* Sets options specific to a subclass.
*
* @param customOptions options specific to a subclass
* @see #getCustomOptions()
*/
protected void setCustomOptions(Parameter[] customOptions) {
if (customOptions == null) {
customOptions = new Parameter[] {};
}
this.customOptions = customOptions;
for (int i = 0; i < customOptions.length; i++) {
handler.addOption(customOptions[i]);
}
}
/**
* Gets options specific to a subclass.
*
* @return options specific to a subclass
* @see #setCustomOptions(Parameter[]) setCustomOptions()
*/
protected Parameter[] getCustomOptions() {
return customOptions;
}
/**
* Called from the parse() method after the command line has been
* parsed. This is where a subclass performs processing specific to
* its custom options.
*
* @param parseStatus the results of the parse() call. Note that
* if dieOnParseError is set, or some
* other AbstractHandlerDecorator exits first, this
* method may never be called.
* @return true if there were no problems
* concerning the custom options, else
* false. The return value from this
* method will be returned from
* {@link #parse(String[]) parse()}.
*/
protected abstract boolean processParsedOptions(boolean parseStatus) ;
/**
* Sets a flag indicating that the program should exit in the case of
* a parse error (after displaying the usage and an error message).
* This flag defaults to true.
*
* @param val true (the default) if the
* parse method should call System.exit() in
* case of a parse error, false if
* parse() should return to the user
* for error processing.
* @see #parse(String[]) parse()
*/
public void setDieOnParseError(boolean val) {
handler.setDieOnParseError(val);
}
/**
* Gets a flag indicating that the program should exit in the case of
* a parse error (after displaying the usage and an error message).
*
* @return true (the default) if the
* parse method should call System.exit() in
* case of a parse error, false if
* parse() should return to the user
* for error processing.
* @see #parse(String[]) parse()
*/
public boolean getDieOnParseError() {
return handler.getDieOnParseError();
}
/**
* parse the specified command line arguments
*
* @param clargs command line arguments passed to the main() method
* of CmdLineHandler's creating class.
* @return This method will exit, rather than returning, if one of the
* following conditions is met:
*
*
-h, or
* -h!, or
* -?,
* are amongst the command line arguments - the
* appropriate information is displayed on stdout,
* and the program exits with status 0.
*
OR, dieOnParseError is set to true AND:
*
*
a command line argument is incorrectly specified -
* an error message is displayed and the program
* exits with status 1.
*
a required command line argument is missing - an error
* message is displayed and the program exits with status 1.
*
*
* If dieOnParseError is set to false,
* this method will return true if there are no parse errors. If
* there are parse errors, falseis returned and
* an appropriate error message may be obtained by calling
* {@link #getParseError()}.
*/
public boolean parse(String[] clargs) {
boolean parseStatus = handler.parse(clargs);
return processParsedOptions(parseStatus);
}
/**
* Sets the parser to be used to parse the command line.
*
* @param parser the parser to be used to parse the command line
* @see #getParser()
*/
public void setParser(CmdLineParser parser) {
handler.setParser(parser);
}
/**
* Gets the parser to be used to parse the command line.
*
* @return the parser to be used to parse the command line
* @see #setParser(CmdLineParser) setParser()
*/
public CmdLineParser getParser() {
return handler.getParser();
}
/**
* sets the value of the arguments (what is left on the command line after
* all options, and their parameters, have been processed) associated
* with the command
*
* @param args A Collection of {@link Parameter} objects. This may
* be null if the command accepts no command line
* arguments.
*/
public void setArgs(Parameter[] args) {
handler.setArgs(args);
}
/**
* Adds a command line arguement.
*
* @param arg the new command line argument
* @throws IllegalArgumentException if arg
* is null.
*/
public void addArg(Parameter arg) {
handler.addArg(arg);
}
/**
* gets the value of the arguments (what is left on the command line after
* all options, and their parameters, have been processed) associated
* with the command
*
* @return the command's options
*/
public List getArgs() {
return handler.getArgs();
}
/**
* gets the argument specified by tag
*
* @param tag identifies the argument to be returned
* @return The argument associated with tag.
* If no matching argument is found, null is returned.
*/
public Parameter getArg(String tag) {
return handler.getArg(tag);
}
/**
* Sets the value of the options associated with the command
*
* @param options A Collection of {@link Parameter} objects. This may
* be null if the command accepts no command line
* options.
*/
public void setOptions(Parameter[] options) {
handler.setOptions(options);
for (int i = 0; i < customOptions.length; i++) {
handler.addOption(customOptions[i]);
}
}
/**
* Adds a command line option. If an option with same tag has already been
* added to this CmdLineHandler, this new option will override the old.
*
* @param opt the new command line option
* @throws IllegalArgumentException if the tag associated with
* opt has already been defined for an
* option.
*/
public void addOption(Parameter opt) {
handler.addOption(opt);
}
/**
* gets the value of the options associated with the command
*
* @return the command's options
*/
public Collection getOptions() {
return handler.getOptions();
}
/**
* gets the option specified by tag
*
* @param tag identifies the option to be returned
* @return the option associated with tag
*/
public Parameter getOption(String tag) {
return handler.getOption(tag);
}
/**
* sets a description of the command's purpose
*
* @param cmdDesc a short description of the command's purpose
* @throws IllegalArgumentException if cmdDesc
* is null or of 0 length.
*/
public void setCmdDesc(String cmdDesc) {
handler.setCmdDesc(cmdDesc);
}
/**
* gets a description of the command's purpose
*
* @return the command's description
*/
public String getCmdDesc() {
return handler.getCmdDesc();
}
/**
* sets the value of the command name associated with this CmdLineHandler
*
* @param cmdName the name of the command associated with this
* CmdLineHandler
* @throws IllegalArgumentException if cmdName is null,
* or of 0 length
*/
public void setCmdName(String cmdName) {
handler.setCmdName(cmdName);
}
/**
* gets the value of the command name associated with this CmdLineHandler
*
* @return the command name
*/
public String getCmdName() {
return handler.getCmdName();
}
/**
* Gets the usage statement associated with the command.
*
* @param hidden indicates whether hidden options are to be included
* in the usage.
* @return the usage statement associated with the command
*/
public String getUsage(boolean hidden) {
return handler.getUsage(hidden);
}
/**
* Sets the error message from the last call to parse().
*
* @param parseError the error message from the last call to parse()
* @see #getParseError()
*/
public void setParseError(String parseError) {
handler.setParseError(parseError);
}
/**
* Gets the error message from the last call to parse().
*
* @return the error message from the last call to parse()
*/
public String getParseError() {
return handler.getParseError();
}
/**
* Prints the usage, followed by the specified error message, to stderr
* and exits the program with exit status = 1. The error message will
* be prefaced with 'ERROR: '.
*
* @param errMsg the error message
* @return Doesn't return - exits the program with exit status
* of 1.
*/
public void exitUsageError(String errMsg) {
handler.exitUsageError(errMsg);
}
}
pdfsam-1.1.4/jcmdline/src/java/jcmdline/BooleanParam.java 0000644 0001750 0001750 00000014134 10201471366 023215 0 ustar twerner twerner /*
* BooleanParam.java
*
* Classes:
* public BooleanParam
*
* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (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.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is the Java jcmdline (command line management) package.
*
* The Initial Developer of the Original Code is Lynne Lawrence.
*
* Portions created by the Initial Developer are Copyright (C) 2002
* the Initial Developer. All Rights Reserved.
*
* Contributor(s): Lynne Lawrence
*
* ***** END LICENSE BLOCK *****
*/
package jcmdline;
/**
* Encapsulate a boolean command line parameter. This parameter defaults
* to "false" if not set by the user.
*
* Sample usage:
*
* BooleanParam deleteOpt =
* new BooleanParam("delete", "delete original file");
* FileParam outfileOpt =
* new FileParam("outfile", "the outfile file - defaults to stdout",
* FileParam.DOESNT_EXIST);
* FileParam infileArg =
* new FileParam("infile", "the input file - defaults to stdin",
* FileParam.IS_READABLE & FileParam.IS_FILE);
* CmdLineHandler clh = new DefaultCmdLineHandler(
* "filter",
* "filters files for obscenities",
* new Parameter[] { deleteOpt, outfileOpt },
* new Parameter[] { infileArg }
* );
* clh.parse(args);
* if (deleteOpt.isTrue()) {
* ....
* }
*
*
* @author Lynne Lawrence
* @version jcmdline Rel. @VERSION@ $Id: BooleanParam.java,v 1.2 2002/12/07 14:22:06 lglawrence Exp $
* @see CmdLineParser
*/
public class BooleanParam extends AbstractParameter
implements OptionTakesNoValue {
/**
* The String value associated with boolean true (i.e. "true" in English).
*/
private String trueValue = Strings.get("BooleanParam.true");
/**
* The String value associated with boolean false (i.e. "false" in English).
*/
private String falseValue = Strings.get("BooleanParam.false");
/**
* constructor - creates a public boolean parameter
*
* @param tag a unique identifier for this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @throws IllegalArgumentException if any specified
* parameter is invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
*/
public BooleanParam(String tag, String desc) {
this(tag, desc, PUBLIC);
}
/**
* constructor - creates a boolean parameter that is public or hidden, as
* specified
*
* @param tag a unique identifier for this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param hidden {@link Parameter#HIDDEN HIDDEN} if parameter is
* not to be listed in the usage,
* {@link Parameter#PUBLIC PUBLIC}
* otherwise.
* @throws IllegalArgumentException if any specified
* parameter is invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see Parameter#HIDDEN HIDDEN
* @see Parameter#PUBLIC PUBLIC
*/
public BooleanParam(String tag,
String desc,
boolean hidden) {
this.setTag(tag);
this.setDesc(desc);
this.setOptional(optional);
this.setMultiValued(SINGLE_VALUED);
this.setHidden(hidden);
this.setOptionLabel("");
this.setAcceptableValues(new String[] { trueValue, falseValue });
try {
this.addValue(falseValue); // defaults to false
this.set = false;
} catch (Exception e) {
// Should never get here
throw new RuntimeException(Strings.get(
"BooleanParam.setValueProgError"));
}
}
/**
* Sets the specified string as a value for this BooleanParam. Any
* previously set value will be discarded.
*
* @param value the value to be set
* @throws CmdLineException
* if {@link #validateValue(String) validateValue()}
* detects a problem.
*/
public void addValue(String value) throws CmdLineException {
validateValue(value);
values.clear();
values.add(value);
set = true;
}
/**
* Gets the default value of this Parameter when used as a command line
* option, and specified just by its tag.
*
* @return the default value of this Parameter
* @see OptionTakesNoValue
*/
public String getDefaultValue() {
return trueValue;
}
/**
* Returns the value of the parameter as a boolean.
*
* @return the parameter value as a boolean
*/
public boolean isTrue() {
return (values.get(0).equals(trueValue) ? true : false);
}
/**
* Verifies that value is either "true" or "false" -
* called by add/setValue(s)().
*
* @param value the value to be validated
* @throws CmdLineException if value is not valid.
*/
public void validateValue(String value) throws CmdLineException {
super.validateValue(value);
}
}
pdfsam-1.1.4/jcmdline/src/java/jcmdline/dto/ 0000755 0001750 0001750 00000000000 10724044440 020574 5 ustar twerner twerner pdfsam-1.1.4/jcmdline/src/java/jcmdline/dto/PdfFile.java 0000644 0001750 0001750 00000006417 10727535520 022767 0 ustar twerner twerner /*
* PdfFile.java
*
* Classes:
* public PdfFile
*
* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (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.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is the Java jcmdline (command line management) package.
*
* The Initial Developer of the Original Code is Lynne Lawrence.
*
* Portions created by the Initial Developer are Copyright (C) 2002
* the Initial Developer. All Rights Reserved.
*
* Contributor(s): Andrea Vacondio
*
* ***** END LICENSE BLOCK *****
*/
package jcmdline.dto;
import java.io.File;
import java.io.Serializable;
public class PdfFile implements Serializable{
private static final long serialVersionUID = 7010970222698392953L;
private File file;
private String password;
public PdfFile(){
}
/**
* @param file
* @param password
*/
public PdfFile(File file, String password) {
this.file = file;
this.password = password;
}
/**
* @param filePath
* @param password
*/
public PdfFile(String filePath, String password) {
this.file = new File(filePath);
this.password = password;
}
/**
* @return the file
*/
public File getFile() {
return file;
}
/**
* @param file the file to set
*/
public void setFile(File file) {
this.file = file;
}
/**
* @return the password
*/
public String getPassword() {
return password;
}
/**
* @return the password in bytes or null
*/
public byte[] getPasswordBytes() {
return (password!=null)? password.getBytes():null;
}
/**
* @param password the password to set
*/
public void setPassword(String password) {
this.password = password;
}
/* (non-Javadoc)
* @see java.lang.Object#hashCode()
*/
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result + ((file == null) ? 0 : file.hashCode());
result = prime * result
+ ((password == null) ? 0 : password.hashCode());
return result;
}
/* (non-Javadoc)
* @see java.lang.Object#equals(java.lang.Object)
*/
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (getClass() != obj.getClass())
return false;
final PdfFile other = (PdfFile) obj;
if (file == null) {
if (other.file != null)
return false;
} else if (!file.equals(other.file))
return false;
if (password == null) {
if (other.password != null)
return false;
} else if (!password.equals(other.password))
return false;
return true;
}
public String toString(){
StringBuffer retVal = new StringBuffer();
retVal.append(super.toString());
retVal.append((file== null)?"":"[file="+file.getAbsolutePath()+"]");
retVal.append("[password="+password+"]");
return retVal.toString();
}
}
pdfsam-1.1.4/jcmdline/src/java/jcmdline/LongParam.java 0000644 0001750 0001750 00000064233 10711672122 022541 0 ustar twerner twerner /*
* LongParam.java
*
* Classes:
* public LongParam
*
* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (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.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is the Java jcmdline (command line management) package.
*
* The Initial Developer of the Original Code is Lynne Lawrence.
*
* Portions created by the Initial Developer are Copyright (C) 2002
* the Initial Developer. All Rights Reserved.
*
* Contributor(s): Andrea Vacondio
*
* ***** END LICENSE BLOCK *****
*/
package jcmdline;
/**
* Encapsulate a command line parameter whose value will be a signed
* long in the same range as a java long.
* @author a.vacondio
*
*/
public class LongParam extends AbstractParameter {
/**
* the default label that will represent option values for this Parameter
* when displaying usage. The following demonstrates a possible usage
* excerpt for a LongParam option, where the option label is '<n>':
*
* count <n> Specifies the maximum number of files to be
* produced by this program.
*
* @see AbstractParameter#setOptionLabel(String) setOptionLabel()
* @see "LongParam.defaultOptionLabel in 'strings' properties file"
*/
public static final String DEFAULT_OPTION_LABEL =
Strings.get("LongParam.defaultOptionLabel");
/**
* the maximum acceptable number - defaults to Integer.MAX_VALUE
*/
protected long max = Long.MAX_VALUE;
/**
* the minimum acceptable number - defaults to Integer.MIN_VALUE
*/
protected long min = Long.MIN_VALUE;
/**
* constructor - creates single-valued, optional, public
* parameter which will
* accept an integer between Integer.MIN_VALUE and Integer.MAX_VALUE.
*
* @param tag a unique identifier for this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @throws IllegalArgumentException if tag
* or are invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
*/
public LongParam(String tag, String desc) {
this(tag, desc, Integer.MIN_VALUE, Integer.MAX_VALUE,
OPTIONAL, SINGLE_VALUED, PUBLIC);
}
/**
* constructor - creates single-valued, public parameter which will
* accept an integer between Integer.MIN_VALUE and Integer.MAX_VALUE, and
* will be either optional or required, as specified.
*
* @param tag a unique identifier for this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param optional {@link Parameter#OPTIONAL OPTIONAL} if
* optional,
* {@link Parameter#REQUIRED REQUIRED} if required
* @throws IllegalArgumentException if any of the specified
* parameters are invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
*/
public LongParam(String tag, String desc, boolean optional) {
this(tag, desc, Long.MIN_VALUE, Long.MAX_VALUE,
optional, SINGLE_VALUED, PUBLIC);
}
/**
* constructor - creates a public parameter which will
* accept an integer between Long.MIN_VALUE and Long.MAX_VALUE, and
* will be either optional or required, and/or multi-valued, as specified.
*
* @param tag a unique identifier for this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param optional {@link Parameter#OPTIONAL OPTIONAL} if
* optional,
* {@link Parameter#REQUIRED REQUIRED} if required
* @param multiValued {@link Parameter#MULTI_VALUED MULTI_VALUED} if
* the parameter can accept multiple values,
* {@link Parameter#SINGLE_VALUED SINGLE_VALUED}
* if the parameter can contain only a single value
* @throws IllegalArgumentException if any of the specified
* parameters are invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see Parameter#SINGLE_VALUED SINGLE_VALUED
* @see Parameter#MULTI_VALUED MULTI_VALUED
*/
public LongParam(String tag,
String desc,
boolean optional,
boolean multiValued) {
this(tag, desc, Long.MIN_VALUE, Long.MAX_VALUE,
optional, multiValued, PUBLIC);
}
/**
* constructor - creates a parameter which will
* accept an integer between Long.MIN_VALUE and Long.MAX_VALUE, and
* will be either optional or required, and/or multi-valued, as specified.
*
* @param tag a unique identifier for this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param optional {@link Parameter#OPTIONAL OPTIONAL} if
* optional,
* {@link Parameter#REQUIRED REQUIRED} if required
* @param multiValued {@link Parameter#MULTI_VALUED MULTI_VALUED} if
* the parameter can accept multiple values,
* {@link Parameter#SINGLE_VALUED SINGLE_VALUED}
* if the parameter can contain only a single value
* @param hidden {@link Parameter#HIDDEN HIDDEN} if parameter is
* not to be listed in the usage,
* {@link Parameter#PUBLIC PUBLIC} otherwise.
* @throws IllegalArgumentException if any of the specified
* parameters are invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see Parameter#SINGLE_VALUED SINGLE_VALUED
* @see Parameter#MULTI_VALUED MULTI_VALUED
* @see Parameter#HIDDEN HIDDEN
* @see Parameter#PUBLIC PUBLIC
*/
public LongParam(String tag,
String desc,
boolean optional,
boolean multiValued,
boolean hidden) {
this(tag, desc, Long.MIN_VALUE, Long.MAX_VALUE,
optional, multiValued, hidden);
}
/**
* constructor - creates a single-valued, optional, public, parameter
* that will accept an integer between the specifed minimum and maximum
* values.
*
* @param tag a unique identifier for this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param min the minimum acceptable value
* @param max the maximum acceptable value
* @throws IllegalArgumentException if any parameter is
* invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see #setMin(int) setMin()
* @see #setMax(int) setMax()
*/
public LongParam(String tag, String desc, long min, long max) {
this(tag, desc, min, max, OPTIONAL, SINGLE_VALUED, PUBLIC);
}
/**
* constructor - creates a single-valued, public parameter
* that will accept an integer between the specifed minimum and maximum
* values, and which is required or optional, as specified.
*
* @param tag a unique identifier for this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param min the minimum acceptable value
* @param max the maximum acceptable value
* @param optional {@link Parameter#OPTIONAL OPTIONAL} if
* optional,
* {@link Parameter#REQUIRED REQUIRED} if required
* @throws IllegalArgumentException if any parameter is
* invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see #setMin(int) setMin()
* @see #setMax(int) setMax()
* @see Parameter#OPTIONAL OPTIONAL
* @see Parameter#REQUIRED REQUIRED
*/
public LongParam(String tag,
String desc,
long min,
long max,
boolean optional) {
this(tag, desc, min, max, optional, SINGLE_VALUED, PUBLIC);
}
/**
* constructor - creates a public parameter
* that will accept an integer between the specifed minimum and maximum
* values, and which is required or optional and/or multi-valued,
* as specified.
*
* @param tag a unique identifier for this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param min the minimum acceptable value
* @param max the maximum acceptable value
* @param optional {@link Parameter#OPTIONAL OPTIONAL} if
* optional,
* {@link Parameter#REQUIRED REQUIRED} if required
* @param multiValued {@link Parameter#MULTI_VALUED MULTI_VALUED} if
* the parameter can accept multiple values,
* {@link Parameter#SINGLE_VALUED SINGLE_VALUED}
* if the parameter can contain only a single value
* @throws IllegalArgumentException if any parameter is
* invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see #setMin(int) setMin()
* @see #setMax(int) setMax()
* @see Parameter#OPTIONAL OPTIONAL
* @see Parameter#REQUIRED REQUIRED
* @see Parameter#SINGLE_VALUED SINGLE_VALUED
* @see Parameter#MULTI_VALUED MULTI_VALUED
*/
public LongParam(String tag,
String desc,
long min,
long max,
boolean optional,
boolean multiValued) {
this(tag, desc, min, max, optional, multiValued, PUBLIC);
}
/**
* constructor - creates a parameter
* that will accept an integer between the specifed minimum and maximum
* values, and for which all other options are specified.
*
* @param tag a unique identifier for this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param min the minimum acceptable value
* @param max the maximum acceptable value
* @param optional {@link Parameter#OPTIONAL OPTIONAL} if
* optional,
* {@link Parameter#REQUIRED REQUIRED} if required
* @param multiValued {@link Parameter#MULTI_VALUED MULTI_VALUED} if
* the parameter can accept multiple values,
* {@link Parameter#SINGLE_VALUED SINGLE_VALUED}
* if the parameter can contain only a single value
* @param hidden {@link Parameter#HIDDEN HIDDEN} if parameter is
* not to be listed in the usage,
* {@link Parameter#PUBLIC PUBLIC} otherwise.
* @throws IllegalArgumentException if any parameter is
* invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see #setMin(int) setMin()
* @see #setMax(int) setMax()
* @see Parameter#OPTIONAL OPTIONAL
* @see Parameter#REQUIRED REQUIRED
* @see Parameter#SINGLE_VALUED SINGLE_VALUED
* @see Parameter#MULTI_VALUED MULTI_VALUED
* @see Parameter#HIDDEN HIDDEN
* @see Parameter#PUBLIC PUBLIC
*/
public LongParam(String tag,
String desc,
long min,
long max,
boolean optional,
boolean multiValued,
boolean hidden) {
this.setTag(tag);
this.setMin(min);
this.setMax(max);
this.setDesc(desc);
this.setOptional(optional);
this.setMultiValued(multiValued);
this.setHidden(hidden);
this.setOptionLabel(DEFAULT_OPTION_LABEL);
}
/**
* constructor - creates a single-valued, optional, public,
* number parameter whose value must be one of the specified values.
*
* @param tag the tag associated with this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param acceptableValues the acceptable values for the parameter
* @throws IllegalArgumentException if any parameter is
* invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see #setAcceptablesLongValues(int[]) setAcceptableIntValues()
*/
public LongParam(String tag, String desc, long[] acceptableValues) {
this(tag, desc, acceptableValues, OPTIONAL, SINGLE_VALUED, PUBLIC);
}
/**
* constructor - creates a single-valued, public,
* number parameter whose value must be one of the specified values,
* and which is required or optional, as specified.
*
* @param tag the tag associated with this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param acceptableValues the acceptable values for the parameter
* @param optional {@link Parameter#OPTIONAL OPTIONAL} if
* optional,
* {@link Parameter#REQUIRED REQUIRED} if required
* @throws IllegalArgumentException if any parameter is
* invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see #setAcceptablesLongValues(int[]) setAcceptableIntValues()
* @see Parameter#OPTIONAL OPTIONAL
* @see Parameter#REQUIRED REQUIRED
*/
public LongParam(String tag,
String desc,
long[] acceptableValues,
boolean optional) {
this(tag, desc, acceptableValues, optional, SINGLE_VALUED, PUBLIC);
}
/**
* constructor - creates a public
* number parameter whose value must be one of the specified values,
* and which is required or optional and/or multi-valued, as specified.
*
* @param tag the tag associated with this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param acceptableValues the acceptable values for the parameter
* @param optional {@link Parameter#OPTIONAL OPTIONAL} if
* optional,
* {@link Parameter#REQUIRED REQUIRED} if required
* @param multiValued {@link Parameter#MULTI_VALUED MULTI_VALUED} if
* the parameter can accept multiple values,
* {@link Parameter#SINGLE_VALUED SINGLE_VALUED}
* if the parameter can contain only a single value
* @throws IllegalArgumentException if any parameter is
* invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see #setAcceptablesLongValues(int[]) setAcceptableIntValues()
* @see Parameter#OPTIONAL OPTIONAL
* @see Parameter#REQUIRED REQUIRED
* @see Parameter#SINGLE_VALUED SINGLE_VALUED
* @see Parameter#MULTI_VALUED MULTI_VALUED
*/
public LongParam(String tag,
String desc,
long[] acceptableValues,
boolean optional,
boolean multiValued) {
this(tag, desc, acceptableValues, optional, multiValued, PUBLIC);
}
/**
* constructor - creates a
* number parameter whose value must be one of the specified values,
* and all of whose other options are specified.
*
* @param tag the tag associated with this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param acceptableValues the acceptable values for the parameter
* @param optional {@link Parameter#OPTIONAL OPTIONAL} if
* optional,
* {@link Parameter#REQUIRED REQUIRED} if required
* @param multiValued {@link Parameter#MULTI_VALUED MULTI_VALUED} if
* the parameter can accept multiple values,
* {@link Parameter#SINGLE_VALUED SINGLE_VALUED}
* if the parameter can contain only a single value
* @param hidden {@link Parameter#HIDDEN HIDDEN} if parameter is
* not to be listed in the usage,
* {@link Parameter#PUBLIC PUBLIC} otherwise.
* @throws IllegalArgumentException if any parameter is
* invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see #setAcceptablesLongValues(int[]) setAcceptableIntValues()
* @see Parameter#OPTIONAL OPTIONAL
* @see Parameter#REQUIRED REQUIRED
* @see Parameter#SINGLE_VALUED SINGLE_VALUED
* @see Parameter#MULTI_VALUED MULTI_VALUED
* @see Parameter#HIDDEN HIDDEN
* @see Parameter#PUBLIC PUBLIC
*/
public LongParam(String tag,
String desc,
long[] acceptableValues,
boolean optional,
boolean multiValued,
boolean hidden) {
this.setTag(tag);
this.setAcceptablesLongValues(acceptableValues);
this.setDesc(desc);
this.setOptional(optional);
this.setMultiValued(multiValued);
this.setHidden(hidden);
this.setOptionLabel(DEFAULT_OPTION_LABEL);
}
/**
* Sets the minimum acceptable value for the parameter's value.
*
* If both acceptableValues and/or a minimum or maximum
* limit for the parameter value are specified, a valid value must
* satisfy all of the constraints.
*
* @param min the minimum acceptable value
* @throws IllegalArgumentException if min is
* greater than max
*/
public void setMin(long min) {
if (min > max) {
throw new IllegalArgumentException(Strings.get(
"LongParam.maxLessThanMin", new Object[] { tag }));
}
this.min = min;
}
/**
* Gets the value of the LongParam as in int. If the LongParam is
* multi-valued, only the first value is returned.
*
* @return the value as an int
* @throws RuntimeException if the value of the LongParam
* has not been set.
* @see Parameter#isSet()
*/
public long longValue() {
if (!set) {
throw new RuntimeException(Strings.get(
"LongParam.valueNotSet", new Object[] { tag }));
}
return Long.parseLong((String)values.get(0));
}
/**
* Gets the values of the LongParam as an int array. Note that if the
* LongParam has no values, an empty array is returned.
*
* @return an array of int values
* @see Parameter#isSet()
*/
public long[] longValues() {
long[] vals = new long[values.size()];
for (int i = 0; i < vals.length; i++) {
vals[i] = Long.parseLong((String)values.get(i));
}
return vals;
}
/**
* gets minimum acceptable value for the parameter's value
*
* @return the minimum acceptable value
*/
public long getMin() {
return min;
}
/**
* Sets the maximum acceptable value for the parameter.
*
* If both acceptableValues and/or a minimum or maximum
* limit for the parameter value are specified, a valid value must
* satisfy all of the constraints.
*
* @param max the maximum acceptable value
* @throws IllegalArgumentException if min is
* greater than max
*/
public void setMax(long max) {
if (min > max) {
throw new IllegalArgumentException(Strings.get(
"LongParam.maxLessThanMin", new Object[] { tag }));
}
this.max = max;
}
/**
* gets the maximum acceptable value for the parameter
*
* @return the maximum acceptable value
*/
public long getMax() {
return max;
}
/**
* Sets the acceptable values for this parameter.
*
* If both acceptableValues and/or a minimum or maximum
* limit for the parameter value are specified, a valid value must
* satisfy all of the constraints.
*
* @param acceptableValues An array of acceptable long values that
* the parameter's values must match. If null,
* the parameter's values can be any long.
*/
public void setAcceptablesLongValues(long[] longValues) {
String[] sValues = new String[longValues.length];
for (int i = 0; i < longValues.length; i++) {
sValues[i] = Long.toString(longValues[i]);
}
setAcceptableValues(sValues);
}
/**
* gets the acceptable values for this parameter
*
* @return The acceptable values for this parameter. If no
* acceptable values have been specified, this
* method returns null.
*/
public long[] getAcceptableLongValues() {
String[] sValues = getAcceptableValues();
long[] longValues = new long[sValues.length];
for (int i = 0; i < sValues.length; i++) {
longValues[i] = Long.parseLong(sValues[i]);
}
return longValues;
}
/**
* Validates a prospective value with regards to the minimum and maximum
* values and the acceptableValues called by add/setValue(s)().
*
* @param val the prospective value to validate
* @throws CmdLineException if
* value is not valid with regard to
# the minimum and
* maximum values, and the acceptableValues.
*/
public void validateValue(String val) throws CmdLineException {
// Strip off any leading 0s before calling
// AbstractParameter.validateValue() because the Strings we sent
// as acceptable values were without.
int offset = 0;
while (val.startsWith("0", offset)) {
offset++;
}
super.validateValue(val.substring(offset));
CmdLineException exception = new CmdLineException(Strings.get(
"LongParam.validValues",
new Object[] { tag,
new Long(min),
new Long(max) }));
long longVal = 0;
try {
longVal = Long.parseLong(val);
} catch (NumberFormatException e) {
throw exception;
}
if (longVal < min || longVal > max) {
throw exception;
}
}
}
pdfsam-1.1.4/jcmdline/src/java/jcmdline/Parameter.java 0000644 0001750 0001750 00000026433 10711667534 022614 0 ustar twerner twerner /*
* Parameter.java
*
* Interface:
* public Parameter
*
* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (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.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is the Java jcmdline (command line management) package.
*
* The Initial Developer of the Original Code is Lynne Lawrence.
*
* Portions created by the Initial Developer are Copyright (C) 2002
* the Initial Developer. All Rights Reserved.
*
* Contributor(s): Lynne Lawrence
*
* ***** END LICENSE BLOCK *****
*/
package jcmdline;
import java.util.Collection;
/**
* Interface for command line parameters.
*
* @author Lynne Lawrence
* @version jcmdline Rel. @VERSION@ $Id: Parameter.java,v 1.2 2002/12/07 14:22:06 lglawrence Exp $
*/
public interface Parameter {
/**
* when used as a value for the hidden indicator,
* indicates that a parameter is public, and its description will be
* listed in the usage.
*/
public static final boolean PUBLIC = false;
/**
* when used as a value for the hidden indicator,
* indicates that a parameter is hidden, and its description will
* not be listed in the usage.
*/
public static final boolean HIDDEN = true;
/**
* when used as a value for the optional indicator,
* specifies that an parameter is optional
*/
public static final boolean OPTIONAL = true;
/**
* when used as a value for the optional indicator,
* specifies that an parameter is required
*/
public static final boolean REQUIRED = false;
/**
* when used as a value for the multiValued indicator,
* specifies that an parameter accepts mulitiple values
*/
public static final boolean MULTI_VALUED = true;
/**
* when used as a value for the multiValued indicator,
* specifies that a parameter accepts only one value
*/
public static final boolean SINGLE_VALUED = false;
/**
* gets an indicator that the parameter's value has been set
*
* @return true if the parameter's value has been set, false
* otherwise
*/
public boolean isSet() ;
/**
* gets the value of the hidden indicator
*
* @return true ({@link #HIDDEN}) if the parameter is a
* hidden parameter
*/
public boolean isHidden() ;
/**
* sets the value of the hidden indicator
*
* @param hidden true ({@link #HIDDEN}) if the parameter is a
* hidden parameter
*/
public void setHidden(boolean hidden) ;
/**
* gets the value of the parameter's description
*
* @return this parameter's description
*/
public String getDesc() ;
/**
* sets the value of this parameter's description
*
* @param desc a description of the parameter, suitable for display in
* the command's usage
* @throws IllegalArgumentException if desc is
* fewer than 5 charaters.
*/
public void setDesc(String desc) throws IllegalArgumentException ;
/**
* gets the value of tag
*
* @return a unique identifier for this parameter
*/
public String getTag() ;
/**
* sets the value of tag
*
* @param tag a unique identifier for this parameter. If the
* parameter is used as an option, it will be used to
* identify the option on the command line. In the case
* where the parameter is used as an argument, it will
* only be used to identify the argument in the usage
* statement. Tags must be made up of any character but
* '='.
* @throws IllegalArgumentException if the length of tag
* is less than 1, or tag contains an
* invalid character.
*/
public void setTag(String tag) throws IllegalArgumentException ;
/**
* gets the value of multiValued indicator
*
* @return true if the parameter can have multiple values
*/
public boolean isMultiValued() ;
/**
* sets the value of the multiValued indicator
*
* @param multiValued true if the parameter can have multiple values
*/
public void setMultiValued(boolean multiValued) ;
/**
* returns the value of the optional indicator
*
* @return true if the parameter is optional
*/
public boolean isOptional() ;
/**
* indicates whether or not the parameter is optional
*
* @param optional true if the parameter is optional
*/
public void setOptional(boolean optional) ;
/**
* Gets the values that are acceptable for this parameter, if a restricted
* set exists. If there is no restricted set of acceptable values, null
* is returned.
*
* @return a set of acceptable values for the Parameter, or
* null if there is none.
*/
public String[] getAcceptableValues() ;
/**
* Sets the values that are acceptable for this parameter, if a restricted
* set exists. A null vals value, or an empty vals
* array, will result in any previously set acceptable values being cleared.
*
* @param vals the new acceptable values
* @see #getAcceptableValues()
*/
public void setAcceptableValues(String[] vals) ;
/**
* Sets the values that are acceptable for this parameter, if a restricted
* set exists. A null vals value, or an empty vals
* Collection, will result in any previously set acceptable values being
* cleared.
*
* The toString() values of the Objects in vals
* will be used for the acceptable values.
*
* @param vals the new acceptable values
*/
public void setAcceptableValues(Collection vals) ;
/**
* adds the specified string as a value for this entity
*
* @param value the value to be added
* @throws CmdLineException if the value of the entity
* has already been set and multiValued is
* not true, or if
* {@link #validateValue(String) validateValue()}
* detects a problem.
*/
public void addValue(String value) throws CmdLineException ;
/**
* Sets the value of the parameter to the specified string.
*
* @param value the new value of the parameter
* @throws if {@link #validateValue(String) validateValue()}
* detects a problem.
*/
public void setValue(String value) throws CmdLineException ;
/**
* Sets the values of the parameter to those specified.
*
* @param values A collection of String objects to be used as the
* parameter's values.
* @throws ClassCastException if the Collection contains object that
* are not Strings.
* @throws CmdLineException if more than one value is specified
* and multiValued is not true, or
* if {@link #validateValue(String) validateValue()}
* detects a problem.
*/
public void setValues(Collection values) throws CmdLineException ;
/**
* Sets the values of the parameter to those specified.
*
* @param values The String objects to be used as the
* parameter's values.
* @throws CmdLineException if more than one value is specified
* and multiValued is not true, or
* if {@link #validateValue(String) validateValue()}
* detects a problem.
*/
public void setValues(String[] values) throws CmdLineException ;
/**
* verifies that value is valid for this entity
*
* @param value the value to be validated
* @throws CmdLineException if value is not valid.
*/
public void validateValue(String value) throws CmdLineException;
/**
* The value of the parameter, in the case where the parameter is not
* multi-valued. For a multi-valued parameter, the first value specified
* is returned.
*
* @return The value of the parameter as a String, or null if
* the paramter has not been set.
* @see #getValues()
*/
public String getValue() ;
/**
* gets the values associated with this Parameter
*
* @return The values associated with this Parameter. Note
* that this might be an empty Collection if the
* Parameter has not been set.
* @see #isSet()
*/
public Collection getValues() ;
/**
* gets the value of optionLabel
*
* @return the string used as a label for the parameter's
* value
*/
public String getOptionLabel() ;
/**
* Sets the value of optionLabel.
* This label will be used when the usage for the command is displayed.
* For instance, a date parameter might use "<mm/dd/yy>". This could
* then be displayed as in the following usage.
*
* st_date <mm/dd/yy> the start date of the report
*
* The default is the empty string.
* @param optionLabel The string used as a label for the parameter's
* value. If null, an empty string is used.
* @see #getOptionLabel()
*/
public void setOptionLabel(String optionLabel) ;
/**
* Gets the flag indicating that during parse, missing required
* Parameters are ignored
* if this Parameter is set. Typically used by Parameters that cause an
* action then call System.exit(), like "-help".
*
* @return true if missing required Parameters
* will be ignored when this Parameter is set.
*/
public boolean getIgnoreRequired() ;
/**
* Sets a flag such that during parse, missing required Parameters are
* ignored
* if this Parameter is set. Typically used by Parameters that cause an
* action then call System.exit(), like "-help".
*
* @param ignoreRequired set to true to ignore missing
* required Parameters if this Parameter is set
* @see #getIgnoreRequired()
*/
public void setIgnoreRequired(boolean ignoreRequired) ;
}
pdfsam-1.1.4/jcmdline/src/java/jcmdline/HelpCmdLineHandler.java 0000644 0001750 0001750 00000057070 10725313406 024306 0 ustar twerner twerner /*
* HelpCmdLineHandler.java
*
* Classes:
* public HelpCmdLineHandler
*
* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (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.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is the Java jcmdline (command line management) package.
*
* The Initial Developer of the Original Code is Lynne Lawrence.
*
* Portions created by the Initial Developer are Copyright (C) 2002
* the Initial Developer. All Rights Reserved.
*
* Contributor(s): Lynne Lawrence
*
* ***** END LICENSE BLOCK *****
*/
package jcmdline;
import java.util.Collection;
/**
* A CmdLineHandler Decorator class that implements help options that
* display verbose help messages.
*
* Options are provided to display a regular help message (which includes
* the regular usage associated with the command) or a help message that
* includes the hidden parameters in its usage and, optionally, additional
* help text specific to the hidden parameters.
*
* The implemented options are BooleanParams whose tags are defined by
* "HelpCmdLineHandler.help.tag" and "HelpCmdLineHandler.helpHidden.tag"
* in the strings.properties file (set to "help" and "help!", in English).
*
* Should the user specify the -help option on the command line, the command's
* usage, followed by the more verbose help text specified to this Object's
* constructor, is printed to stdout, and System.exit(0) is called.
*
* Should the -help! option be specified the same is done, but hidden
* parameter information and help is displayed as well.
*
* Sample Usage
* The following creates a CmdLineHandler that uses multiple Decorators
* to enable the help options supported by this class, the version option
* implemented by the {@link VersionCmdLineHandler} class, and the usage
* options implemented by the {@link DefaultCmdLineHandler} class:
*
* public static void main(String[] args) {
*
* Parameter[] arguments = new Parameter[] {
* new StringParam("pattern", "the pattern to match",
* StringParam.REQUIRED),
* new FileParam("file",
* "a file to be processed - defaults to stdin",
* FileParam.IS_FILE & FileParam.IS_READABLE,
* FileParam.OPTIONAL,
* FileParam.MULTI_VALUED)
* };
* Parameter[] opts = new Parameter[] {
* new BooleanParam("ignorecase", "ignore case while matching"),
* new BooleanParam("listFiles", "list filenames containing pattern")
* };
* String helpText = "This command prints to stdout all lines within " +
* "the specified files that contain the specified " +
* "pattern.\n\n" +
* "Optionally, the matching may be done without " +
* "regard to case (using the -ignorecase option).\n\n" +
* "If the -listFiles option is specified, only the " +
* "names of the files containing the pattern will be " +
* "listed.";
*
* CmdLineHandler cl =
* new VersionCmdLineHandler("V 5.2",
* new HelpCmdLineHandler(helpText,
* "grep",
* "find lines in files containing a specified pattern",
* opts,
* arguments));
* cl.parse(args);
* .
* .
*
* The help text for a command will be formatted for output such that:
*
*
All lines will be word wrapped at the appropriate line length by the
* formatter - it is suggested
* that the user let the program handle line wrapping for best results,
* except when a new paragraph is starting.
*
Newlines (\n), and leading spaces that immediately follow a
* newline, in the text will be honored - it is recommended that
* they be used to mark new paragraphs, and when formatting/indenting
* lines.
*
*
* Information on using CmdLineHandlers can be found in the jcmdline
* User Guide.
*
* @author Lynne Lawrence
* @version 2007-Dec-04 modified by Andrea Vacondio, added -license param
* @see CmdLineHandler
* @see AbstractHandlerDecorator
*/
public class HelpCmdLineHandler extends AbstractHandlerDecorator {
/**
* a parameter that will cause standard help to be displayed
*/
private BooleanParam helpOpt;
/**
* a parameter that will cause license to be displayed
*/
private BooleanParam licenseOpt;
/**
* a parameter that will cause help including hidden information to be
* displayed
*/
private BooleanParam hiddenHelpOpt;
/**
* the command's help
*/
private String help;
/**
* the license
*/
private String license;
/**
* the command's help for hidden Parameters
*/
private String hiddenHelp;
/**
* constructor
*
* @param help the command's help - see Help
* Text Formatting.
* @param hiddenHelp the command's help for hidden Parameters - may
* be null or empty
* @param handler the CmdLineHandler to which most functionality
* will be delegated
* @throws IllegalArgumentException if help is null or
* empty.
*/
public HelpCmdLineHandler (String help,
String license,
String hiddenHelp,
CmdLineHandler handler) {
super(handler);
if (help == null || help.length() == 0) {
throw new IllegalArgumentException(Strings.get(
"HelpCmdLineHandler.helpEmptyError"));
}
this.help = help;
if (license == null || license.length() == 0) {
this.license = Strings.get("HelpCmdLineHandler.license.nolicense");
} else {
this.license = license;
}
if (hiddenHelp == null || hiddenHelp.length() == 0) {
this.hiddenHelp = null;
} else {
this.hiddenHelp = hiddenHelp;
}
helpOpt = new BooleanParam(
Strings.get("HelpCmdLineHandler.help.tag"),
Strings.get("HelpCmdLineHandler.help.desc"));
helpOpt.setIgnoreRequired(true);
licenseOpt = new BooleanParam(
Strings.get("HelpCmdLineHandler.license.tag"),
Strings.get("HelpCmdLineHandler.license.desc"));
licenseOpt.setIgnoreRequired(true);
hiddenHelpOpt = new BooleanParam(
Strings.get("HelpCmdLineHandler.helpHidden.tag"),
Strings.get("HelpCmdLineHandler.helpHidden.desc"),
BooleanParam.HIDDEN);
hiddenHelpOpt.setIgnoreRequired(true);
setCustomOptions(new Parameter[] { helpOpt, hiddenHelpOpt, licenseOpt });
}
/**
* constructor
*
* @param help the command's help - see Help
* Text Formatting.
* @param handler the CmdLineHandler to which most functionality
* will be delegated
* @throws IllegalArgumentException if help is null or
* empty.
*/
public HelpCmdLineHandler (String help, CmdLineHandler handler) {
this(help, null, null, handler);
}
/**
*
* @param help the command's help - see Help
* Text Formatting.
* @param license the license informations
* @param handler the CmdLineHandler to which most functionality
* will be delegated
* @throws IllegalArgumentException if help is null or
* empty.
*/
public HelpCmdLineHandler (String help, String license, CmdLineHandler handler) {
this(help, license, null, handler);
}
/**
* constructor - creates a new DefaultCmdLineHandler as its delegate
*
* @param help the command's help - see
* Help Text Formatting.
* @param cmdName the name of the command
* @param cmdDesc a short description of the command
* @param options a collection of Parameter objects, describing the
* command's command-line options
* @param args a collection of Parameter objects, describing the
* command's command-line arguments (what is left on
* the command line after all options and their
* parameters have been processed)
* @param parser a CmdLineParser to be used to parse the command line
* @throws IllegalArgumentException if any of the
* parameters are not correctly specified.
* @see DefaultCmdLineHandler
*/
public HelpCmdLineHandler (String help,
String cmdName,
String cmdDesc,
Parameter[] options,
Parameter[] args,
CmdLineParser parser) {
this(help, null, null,
new DefaultCmdLineHandler(cmdName, cmdDesc, options, args, parser));
}
/**
* constructor - creates a new DefaultCmdLineHandler as its delegate
*
* @param help the command's help - see
* Help Text Formatting.
* @param cmdName the name of the command
* @param cmdDesc a short description of the command
* @param options a collection of Parameter objects, describing the
* command's command-line options
* @param args a collection of Parameter objects, describing the
* command's command-line arguments (what is left on
* the command line after all options and their
* parameters have been processed)
* @throws IllegalArgumentException if any of the
* parameters are not correctly specified.
* @see DefaultCmdLineHandler
*/
public HelpCmdLineHandler (String help,
String cmdName,
String cmdDesc,
Parameter[] options,
Parameter[] args) {
this(help, null, null,
new DefaultCmdLineHandler(cmdName, cmdDesc, options, args));
}
/**
* constructor - uses the PosixCmdLineParser to parse the command line
*
* @param help the command's help - see
* Help Text Formatting.
* @param cmdName the name of the command creating this
* DefaultCmdLineHandler
* @param cmdDesc a short description of the command's purpose
* @param options a collection of Parameter objects, describing the
* command's command-line options
* @param args a collection of Parameter objects, describing the
* command's command-line arguments (what is left on
* the command line after all options and their
* parameters have been processed)
* @throws IllegalArgumentException if any of the
* parameters are not correctly specified.
* @see #setCmdName(String) setCmdName()
* @see #setCmdDesc(String) setCmdDesc()
* @see #setOptions(Parameter[]) setOptions()
* @see PosixCmdLineParser
*/
public HelpCmdLineHandler (String help,
String cmdName,
String cmdDesc,
Collection options,
Collection args) {
this(help, null, null,
new DefaultCmdLineHandler(cmdName, cmdDesc, options, args));
}
/**
* constructor - creates a new DefaultCmdLineHandler as its delegate
*
* @param help the command's help - see
* Help Text Formatting.
* @param hiddenHelp the command's help for hidden Parameters - may
* be null or empty
* @param cmdName the name of the command
* @param cmdDesc a short description of the command
* @param options a collection of Parameter objects, describing the
* command's command-line options
* @param args a collection of Parameter objects, describing the
* command's command-line arguments (what is left on
* the command line after all options and their
* parameters have been processed)
* @param parser a CmdLineParser to be used to parse the command line
* @throws IllegalArgumentException if any of the
* parameters are not correctly specified.
* @see DefaultCmdLineHandler
*/
public HelpCmdLineHandler (String help,
String hiddenHelp,
String cmdName,
String cmdDesc,
Parameter[] options,
Parameter[] args,
CmdLineParser parser) {
this(help, null, hiddenHelp,
new DefaultCmdLineHandler(cmdName, cmdDesc, options, args, parser));
}
/**
*
* @param help the command's help - see
* Help Text Formatting.
* @param license license informations
* @param hiddenHelp the command's help for hidden Parameters - may
* be null or empty
* @param cmdName the name of the command
* @param cmdDesc a short description of the command
* @param options a collection of Parameter objects, describing the
* command's command-line options
* @param args a collection of Parameter objects, describing the
* command's command-line arguments (what is left on
* the command line after all options and their
* parameters have been processed)
* @param parser a CmdLineParser to be used to parse the command line
* @throws IllegalArgumentException if any of the
* parameters are not correctly specified.
* @see DefaultCmdLineHandler
*/
public HelpCmdLineHandler (String help,
String license,
String hiddenHelp,
String cmdName,
String cmdDesc,
Parameter[] options,
Parameter[] args,
CmdLineParser parser) {
this(help, license, hiddenHelp,
new DefaultCmdLineHandler(cmdName, cmdDesc, options, args, parser));
}
/**
* constructor - creates a new DefaultCmdLineHandler as its delegate
*
* @param help the command's help - see
* Help Text Formatting.
* @param hiddenHelp the command's help for hidden Parameters - may
* be null or empty
* @param cmdName the name of the command
* @param cmdDesc a short description of the command
* @param options a collection of Parameter objects, describing the
* command's command-line options
* @param args a collection of Parameter objects, describing the
* command's command-line arguments (what is left on
* the command line after all options and their
* parameters have been processed)
* @throws IllegalArgumentException if any of the
* parameters are not correctly specified.
* @see DefaultCmdLineHandler
*/
public HelpCmdLineHandler (String help,
String hiddenHelp,
String cmdName,
String cmdDesc,
Parameter[] options,
Parameter[] args) {
this(help, null, hiddenHelp,
new DefaultCmdLineHandler(cmdName, cmdDesc, options, args));
}
/**
*
* @param help the command's help - see
* Help Text Formatting.
* @param license license informations
* @param hiddenHelp the command's help for hidden Parameters - may
* be null or empty
* @param cmdName the name of the command
* @param cmdDesc a short description of the command
* @param options a collection of Parameter objects, describing the
* command's command-line options
* @param args a collection of Parameter objects, describing the
* command's command-line arguments (what is left on
* the command line after all options and their
* parameters have been processed)
* @throws IllegalArgumentException if any of the
* parameters are not correctly specified.
* @see DefaultCmdLineHandler */
public HelpCmdLineHandler (String help,
String license,
String hiddenHelp,
String cmdName,
String cmdDesc,
Parameter[] options,
Parameter[] args) {
this(help, license, hiddenHelp,
new DefaultCmdLineHandler(cmdName, cmdDesc, options, args));
}
/**
* constructor - uses the PosixCmdLineParser to parse the command line
*
* @param help the command's help - see
* Help Text Formatting.
* @param license license informations
* @param hiddenHelp the command's help for hidden Parameters - may
* be null or empty
* @param cmdName the name of the command creating this
* DefaultCmdLineHandler
* @param cmdDesc a short description of the command's purpose
* @param options a collection of Parameter objects, describing the
* command's command-line options
* @param args a collection of Parameter objects, describing the
* command's command-line arguments (what is left on
* the command line after all options and their
* parameters have been processed)
* @throws IllegalArgumentException if any of the
* parameters are not correctly specified.
* @see #setCmdName(String) setCmdName()
* @see #setCmdDesc(String) setCmdDesc()
* @see #setOptions(Parameter[]) setOptions()
* @see PosixCmdLineParser
*/
public HelpCmdLineHandler (String help,
String hiddenHelp,
String cmdName,
String cmdDesc,
Collection options,
Collection args) {
this(help, null, hiddenHelp,
new DefaultCmdLineHandler(cmdName, cmdDesc, options, args));
}
/**
* constructor - uses the PosixCmdLineParser to parse the command line
*
* @param help the command's help - see
* Help Text Formatting.
* @param hiddenHelp the command's help for hidden Parameters - may
* be null or empty
* @param cmdName the name of the command creating this
* DefaultCmdLineHandler
* @param cmdDesc a short description of the command's purpose
* @param options a collection of Parameter objects, describing the
* command's command-line options
* @param args a collection of Parameter objects, describing the
* command's command-line arguments (what is left on
* the command line after all options and their
* parameters have been processed)
* @throws IllegalArgumentException if any of the
* parameters are not correctly specified.
* @see #setCmdName(String) setCmdName()
* @see #setCmdDesc(String) setCmdDesc()
* @see #setOptions(Parameter[]) setOptions()
* @see PosixCmdLineParser
*/
public HelpCmdLineHandler (String help,
String license,
String hiddenHelp,
String cmdName,
String cmdDesc,
Collection options,
Collection args) {
this(help, license, hiddenHelp,
new DefaultCmdLineHandler(cmdName, cmdDesc, options, args));
}
/**
* Called following the call to parse() of this class's
* contained CmdLineHandler. This method checks for its option whether
* parseStatus is true or not.
*
* @param parseStatus The result of the parse() call to this
* class's contained CmdLineHandler.
* @return This method will call System.exit(0), rather
* than returning, if its option is set.
* Otherwise, parseStatus is returned.
*/
protected boolean processParsedOptions(boolean parseOk) {
if ( helpOpt.isTrue() || hiddenHelpOpt.isTrue() || licenseOpt.isTrue()) {
if ( helpOpt.isTrue() || hiddenHelpOpt.isTrue() ) {
System.out.println(getUsage(hiddenHelpOpt.isTrue()));
int lineLen = getParser().getUsageFormatter().getLineLength();
StringFormatHelper sHelper = StringFormatHelper.getHelper();
System.out.println(
"\n" + sHelper.formatBlockedText(help, 0, lineLen));
if (hiddenHelpOpt.isTrue() && hiddenHelp != null) {
System.out.println(
"\n" + sHelper.formatBlockedText(hiddenHelp, 0, lineLen));
}
}else{
if(licenseOpt.isTrue()){
if (license != null) {
int lineLen = getParser().getUsageFormatter().getLineLength();
StringFormatHelper sHelper = StringFormatHelper.getHelper();
System.out.println(
"\n" + sHelper.formatBlockedText(license, 0, lineLen));
}
}
}
System.exit(0);
}
return parseOk;
}
}
pdfsam-1.1.4/jcmdline/src/java/jcmdline/DefaultCmdLineHandler.java 0000644 0001750 0001750 00000020043 10722536224 024772 0 ustar twerner twerner /*
* DefaultCmdLineHandler.java
*
* Classes:
* public DefaultCmdLineHandler
*
* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (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.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is the Java jcmdline (command line management) package.
*
* The Initial Developer of the Original Code is Lynne Lawrence.
*
* Portions created by the Initial Developer are Copyright (C) 2002
* the Initial Developer. All Rights Reserved.
*
* Contributor(s): Lynne Lawrence
*
* ***** END LICENSE BLOCK *****
*/
package jcmdline;
import java.util.Collection;
/**
* A Decorator class that implements command line options for the
* display of the command's usage.
* These options are (using the default 'strings' properties file):
*
* -? prints usage to stdout (optional)
* -h prints usage to stdout (optional)
* -h! prints usage (including hidden options) to stdout (optional)
* (hidden)
*
*
* Should any of these options be specified by the user, the usage (with or
* without the hidden options, as appropriate) will be displayed and
* System.exit(0) will be called.
*
* Information on using CmdLineHandlers can be found in the jcmdline
* User Guide.
*
* @author Lynne Lawrence
* @version jcmdline Rel. @VERSION@ $Id: DefaultCmdLineHandler.java,v 1.2 2002/12/07 14:22:06 lglawrence Exp $
* @see Parameter
* @see BasicCmdLineHandler
* @see CmdLineParser
*/
public class DefaultCmdLineHandler extends AbstractHandlerDecorator {
/**
* a parameter that will cause the usage to be displayed
*/
private BooleanParam usageParam1;
/**
* a second parameter that will cause the usage to be displayed
*/
private BooleanParam usageParam2;
/**
* a parameter that will cause the usage to be displayed, including
* hidden options
*/
private BooleanParam hiddenUsageParam;
/**
* constructor
*
* @param handler the CmdLineHandler to which most functionality
* will be delegated
*/
public DefaultCmdLineHandler (CmdLineHandler handler) {
super(handler);
usageParam1 = new BooleanParam(
Strings.get("DefaultCmdLineHandler.usageOptTag1"),
Strings.get("DefaultCmdLineHandler.usageOptDesc"));
usageParam1.setIgnoreRequired(true);
usageParam2 = new BooleanParam(
Strings.get("DefaultCmdLineHandler.usageOptTag2"),
Strings.get("DefaultCmdLineHandler.usageOptDesc"));
usageParam2.setIgnoreRequired(true);
hiddenUsageParam = new BooleanParam(
Strings.get("DefaultCmdLineHandler.hiddenUsageOptTag"),
Strings.get("DefaultCmdLineHandler.hiddenUsageOptDesc"),
BooleanParam.HIDDEN);
hiddenUsageParam.setIgnoreRequired(true);
setCustomOptions(new Parameter[] { usageParam1,
usageParam2,
hiddenUsageParam });
}
/**
* constructor - creates a new BasicCmdLineHandler as its delegate
*
* @param cmdName the name of the command
* @param cmdDesc a short description of the command
* @param options a collection of Parameter objects, describing the
* command's command-line options
* @param args a collection of Parameter objects, describing the
* command's command-line arguments (what is left on
* the command line after all options and their
* parameters have been processed)
* @param parser a CmdLineParser to be used to parse the command line
* @throws IllegalArgumentException if any of the
* parameters are not correctly specified.
* @see BasicCmdLineHandler
*/
public DefaultCmdLineHandler (String cmdName,
String cmdDesc,
Parameter[] options,
Parameter[] args,
CmdLineParser parser) {
this(new BasicCmdLineHandler(cmdName, cmdDesc, options, args, parser));
}
/**
* constructor - creates a new BasicCmdLineHandler as its delegate
*
* @param cmdName the name of the command
* @param cmdDesc a short description of the command
* @param options a collection of Parameter objects, describing the
* command's command-line options
* @param args a collection of Parameter objects, describing the
* command's command-line arguments (what is left on
* the command line after all options and their
* parameters have been processed)
* @throws IllegalArgumentException if any of the
* parameters are not correctly specified.
* @see BasicCmdLineHandler
*/
public DefaultCmdLineHandler (String cmdName,
String cmdDesc,
Parameter[] options,
Parameter[] args) {
this(new BasicCmdLineHandler(cmdName, cmdDesc, options, args));
}
/**
* constructor - uses the PosixCmdLineParser to parse the command line
*
* @param cmdName the name of the command creating this
* BasicCmdLineHandler
* @param cmdDesc a short description of the command's purpose
* @param options a collection of Parameter objects, describing the
* command's command-line options
* @param args a collection of Parameter objects, describing the
* command's command-line arguments (what is left on
* the command line after all options and their
* parameters have been processed)
* @throws IllegalArgumentException if any of the
* parameters are not correctly specified.
* @see #setCmdName(String) setCmdName()
* @see #setCmdDesc(String) setCmdDesc()
* @see #setOptions(Parameter[]) setOptions()
* @see PosixCmdLineParser
*/
public DefaultCmdLineHandler (String cmdName,
String cmdDesc,
Collection options,
Collection args) {
this(new BasicCmdLineHandler(cmdName, cmdDesc, options, args));
}
/**
* Called following the call to parse() of this class's
* contained CmdLineHandler. This method checks for its options even if
* parseStatus is false.
*
* @param parseStatus The result of the parse() call to this
* class's contained CmdLineHandler.
* @return This method will call System.exit(0),
* rather than returning, if one of its
* supported options (-h, -h!, or -?) is
* specified. Otherwise, parseStatus is returned.
*/
protected boolean processParsedOptions(boolean parseStatus) {
if (usageParam1.isSet() || usageParam2.isSet()) {
System.out.println(getUsage(false));
System.exit(0);
} else if (hiddenUsageParam.isSet()) {
System.out.println(getUsage(true));
System.exit(0);
}
return parseStatus;
}
}
pdfsam-1.1.4/jcmdline/src/java/jcmdline/IntParam.java 0000644 0001750 0001750 00000063333 10201471366 022375 0 ustar twerner twerner /*
* IntParam.java
*
* Classes:
* public IntParam
*
* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (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.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is the Java jcmdline (command line management) package.
*
* The Initial Developer of the Original Code is Lynne Lawrence.
*
* Portions created by the Initial Developer are Copyright (C) 2002
* the Initial Developer. All Rights Reserved.
*
* Contributor(s): Lynne Lawrence
*
* ***** END LICENSE BLOCK *****
*/
package jcmdline;
/**
* Encapsulate a command line parameter whose value will be a signed
* integer in the same range as a java int.
*
* @author Lynne Lawrence
* @version jcmdline Rel. @VERSION@ $Id: IntParam.java,v 1.2 2002/12/07 14:22:06 lglawrence Exp $
* @see CmdLineParser
*/
public class IntParam extends AbstractParameter {
/**
* the default label that will represent option values for this Parameter
* when displaying usage. The following demonstrates a possible usage
* excerpt for a IntParam option, where the option label is '<n>':
*
* count <n> Specifies the maximum number of files to be
* produced by this program.
*
* @see AbstractParameter#setOptionLabel(String) setOptionLabel()
* @see "IntParam.defaultOptionLabel in 'strings' properties file"
*/
public static final String DEFAULT_OPTION_LABEL =
Strings.get("IntParam.defaultOptionLabel");
/**
* the maximum acceptable number - defaults to Integer.MAX_VALUE
*/
protected int max = Integer.MAX_VALUE;
/**
* the minimum acceptable number - defaults to Integer.MIN_VALUE
*/
protected int min = Integer.MIN_VALUE;
/**
* constructor - creates single-valued, optional, public
* parameter which will
* accept an integer between Integer.MIN_VALUE and Integer.MAX_VALUE.
*
* @param tag a unique identifier for this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @throws IllegalArgumentException if tag
* or are invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
*/
public IntParam(String tag, String desc) {
this(tag, desc, Integer.MIN_VALUE, Integer.MAX_VALUE,
OPTIONAL, SINGLE_VALUED, PUBLIC);
}
/**
* constructor - creates single-valued, public parameter which will
* accept an integer between Integer.MIN_VALUE and Integer.MAX_VALUE, and
* will be either optional or required, as specified.
*
* @param tag a unique identifier for this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param optional {@link Parameter#OPTIONAL OPTIONAL} if
* optional,
* {@link Parameter#REQUIRED REQUIRED} if required
* @throws IllegalArgumentException if any of the specified
* parameters are invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
*/
public IntParam(String tag, String desc, boolean optional) {
this(tag, desc, Integer.MIN_VALUE, Integer.MAX_VALUE,
optional, SINGLE_VALUED, PUBLIC);
}
/**
* constructor - creates a public parameter which will
* accept an integer between Integer.MIN_VALUE and Integer.MAX_VALUE, and
* will be either optional or required, and/or multi-valued, as specified.
*
* @param tag a unique identifier for this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param optional {@link Parameter#OPTIONAL OPTIONAL} if
* optional,
* {@link Parameter#REQUIRED REQUIRED} if required
* @param multiValued {@link Parameter#MULTI_VALUED MULTI_VALUED} if
* the parameter can accept multiple values,
* {@link Parameter#SINGLE_VALUED SINGLE_VALUED}
* if the parameter can contain only a single value
* @throws IllegalArgumentException if any of the specified
* parameters are invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see Parameter#SINGLE_VALUED SINGLE_VALUED
* @see Parameter#MULTI_VALUED MULTI_VALUED
*/
public IntParam(String tag,
String desc,
boolean optional,
boolean multiValued) {
this(tag, desc, Integer.MIN_VALUE, Integer.MAX_VALUE,
optional, multiValued, PUBLIC);
}
/**
* constructor - creates a parameter which will
* accept an integer between Integer.MIN_VALUE and Integer.MAX_VALUE, and
* will be either optional or required, and/or multi-valued, as specified.
*
* @param tag a unique identifier for this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param optional {@link Parameter#OPTIONAL OPTIONAL} if
* optional,
* {@link Parameter#REQUIRED REQUIRED} if required
* @param multiValued {@link Parameter#MULTI_VALUED MULTI_VALUED} if
* the parameter can accept multiple values,
* {@link Parameter#SINGLE_VALUED SINGLE_VALUED}
* if the parameter can contain only a single value
* @param hidden {@link Parameter#HIDDEN HIDDEN} if parameter is
* not to be listed in the usage,
* {@link Parameter#PUBLIC PUBLIC} otherwise.
* @throws IllegalArgumentException if any of the specified
* parameters are invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see Parameter#SINGLE_VALUED SINGLE_VALUED
* @see Parameter#MULTI_VALUED MULTI_VALUED
* @see Parameter#HIDDEN HIDDEN
* @see Parameter#PUBLIC PUBLIC
*/
public IntParam(String tag,
String desc,
boolean optional,
boolean multiValued,
boolean hidden) {
this(tag, desc, Integer.MIN_VALUE, Integer.MAX_VALUE,
optional, multiValued, hidden);
}
/**
* constructor - creates a single-valued, optional, public, parameter
* that will accept an integer between the specifed minimum and maximum
* values.
*
* @param tag a unique identifier for this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param min the minimum acceptable value
* @param max the maximum acceptable value
* @throws IllegalArgumentException if any parameter is
* invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see #setMin(int) setMin()
* @see #setMax(int) setMax()
*/
public IntParam(String tag, String desc, int min, int max) {
this(tag, desc, min, max, OPTIONAL, SINGLE_VALUED, PUBLIC);
}
/**
* constructor - creates a single-valued, public parameter
* that will accept an integer between the specifed minimum and maximum
* values, and which is required or optional, as specified.
*
* @param tag a unique identifier for this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param min the minimum acceptable value
* @param max the maximum acceptable value
* @param optional {@link Parameter#OPTIONAL OPTIONAL} if
* optional,
* {@link Parameter#REQUIRED REQUIRED} if required
* @throws IllegalArgumentException if any parameter is
* invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see #setMin(int) setMin()
* @see #setMax(int) setMax()
* @see Parameter#OPTIONAL OPTIONAL
* @see Parameter#REQUIRED REQUIRED
*/
public IntParam(String tag,
String desc,
int min,
int max,
boolean optional) {
this(tag, desc, min, max, optional, SINGLE_VALUED, PUBLIC);
}
/**
* constructor - creates a public parameter
* that will accept an integer between the specifed minimum and maximum
* values, and which is required or optional and/or multi-valued,
* as specified.
*
* @param tag a unique identifier for this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param min the minimum acceptable value
* @param max the maximum acceptable value
* @param optional {@link Parameter#OPTIONAL OPTIONAL} if
* optional,
* {@link Parameter#REQUIRED REQUIRED} if required
* @param multiValued {@link Parameter#MULTI_VALUED MULTI_VALUED} if
* the parameter can accept multiple values,
* {@link Parameter#SINGLE_VALUED SINGLE_VALUED}
* if the parameter can contain only a single value
* @throws IllegalArgumentException if any parameter is
* invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see #setMin(int) setMin()
* @see #setMax(int) setMax()
* @see Parameter#OPTIONAL OPTIONAL
* @see Parameter#REQUIRED REQUIRED
* @see Parameter#SINGLE_VALUED SINGLE_VALUED
* @see Parameter#MULTI_VALUED MULTI_VALUED
*/
public IntParam(String tag,
String desc,
int min,
int max,
boolean optional,
boolean multiValued) {
this(tag, desc, min, max, optional, multiValued, PUBLIC);
}
/**
* constructor - creates a parameter
* that will accept an integer between the specifed minimum and maximum
* values, and for which all other options are specified.
*
* @param tag a unique identifier for this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param min the minimum acceptable value
* @param max the maximum acceptable value
* @param optional {@link Parameter#OPTIONAL OPTIONAL} if
* optional,
* {@link Parameter#REQUIRED REQUIRED} if required
* @param multiValued {@link Parameter#MULTI_VALUED MULTI_VALUED} if
* the parameter can accept multiple values,
* {@link Parameter#SINGLE_VALUED SINGLE_VALUED}
* if the parameter can contain only a single value
* @param hidden {@link Parameter#HIDDEN HIDDEN} if parameter is
* not to be listed in the usage,
* {@link Parameter#PUBLIC PUBLIC} otherwise.
* @throws IllegalArgumentException if any parameter is
* invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see #setMin(int) setMin()
* @see #setMax(int) setMax()
* @see Parameter#OPTIONAL OPTIONAL
* @see Parameter#REQUIRED REQUIRED
* @see Parameter#SINGLE_VALUED SINGLE_VALUED
* @see Parameter#MULTI_VALUED MULTI_VALUED
* @see Parameter#HIDDEN HIDDEN
* @see Parameter#PUBLIC PUBLIC
*/
public IntParam(String tag,
String desc,
int min,
int max,
boolean optional,
boolean multiValued,
boolean hidden) {
this.setTag(tag);
this.setMin(min);
this.setMax(max);
this.setDesc(desc);
this.setOptional(optional);
this.setMultiValued(multiValued);
this.setHidden(hidden);
this.setOptionLabel(DEFAULT_OPTION_LABEL);
}
/**
* constructor - creates a single-valued, optional, public,
* number parameter whose value must be one of the specified values.
*
* @param tag the tag associated with this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param acceptableValues the acceptable values for the parameter
* @throws IllegalArgumentException if any parameter is
* invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see #setAcceptableIntValues(int[]) setAcceptableIntValues()
*/
public IntParam(String tag, String desc, int[] acceptableValues) {
this(tag, desc, acceptableValues, OPTIONAL, SINGLE_VALUED, PUBLIC);
}
/**
* constructor - creates a single-valued, public,
* number parameter whose value must be one of the specified values,
* and which is required or optional, as specified.
*
* @param tag the tag associated with this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param acceptableValues the acceptable values for the parameter
* @param optional {@link Parameter#OPTIONAL OPTIONAL} if
* optional,
* {@link Parameter#REQUIRED REQUIRED} if required
* @throws IllegalArgumentException if any parameter is
* invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see #setAcceptableIntValues(int[]) setAcceptableIntValues()
* @see Parameter#OPTIONAL OPTIONAL
* @see Parameter#REQUIRED REQUIRED
*/
public IntParam(String tag,
String desc,
int[] acceptableValues,
boolean optional) {
this(tag, desc, acceptableValues, optional, SINGLE_VALUED, PUBLIC);
}
/**
* constructor - creates a public
* number parameter whose value must be one of the specified values,
* and which is required or optional and/or multi-valued, as specified.
*
* @param tag the tag associated with this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param acceptableValues the acceptable values for the parameter
* @param optional {@link Parameter#OPTIONAL OPTIONAL} if
* optional,
* {@link Parameter#REQUIRED REQUIRED} if required
* @param multiValued {@link Parameter#MULTI_VALUED MULTI_VALUED} if
* the parameter can accept multiple values,
* {@link Parameter#SINGLE_VALUED SINGLE_VALUED}
* if the parameter can contain only a single value
* @throws IllegalArgumentException if any parameter is
* invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see #setAcceptableIntValues(int[]) setAcceptableIntValues()
* @see Parameter#OPTIONAL OPTIONAL
* @see Parameter#REQUIRED REQUIRED
* @see Parameter#SINGLE_VALUED SINGLE_VALUED
* @see Parameter#MULTI_VALUED MULTI_VALUED
*/
public IntParam(String tag,
String desc,
int[] acceptableValues,
boolean optional,
boolean multiValued) {
this(tag, desc, acceptableValues, optional, multiValued, PUBLIC);
}
/**
* constructor - creates a
* number parameter whose value must be one of the specified values,
* and all of whose other options are specified.
*
* @param tag the tag associated with this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param acceptableValues the acceptable values for the parameter
* @param optional {@link Parameter#OPTIONAL OPTIONAL} if
* optional,
* {@link Parameter#REQUIRED REQUIRED} if required
* @param multiValued {@link Parameter#MULTI_VALUED MULTI_VALUED} if
* the parameter can accept multiple values,
* {@link Parameter#SINGLE_VALUED SINGLE_VALUED}
* if the parameter can contain only a single value
* @param hidden {@link Parameter#HIDDEN HIDDEN} if parameter is
* not to be listed in the usage,
* {@link Parameter#PUBLIC PUBLIC} otherwise.
* @throws IllegalArgumentException if any parameter is
* invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see #setAcceptableIntValues(int[]) setAcceptableIntValues()
* @see Parameter#OPTIONAL OPTIONAL
* @see Parameter#REQUIRED REQUIRED
* @see Parameter#SINGLE_VALUED SINGLE_VALUED
* @see Parameter#MULTI_VALUED MULTI_VALUED
* @see Parameter#HIDDEN HIDDEN
* @see Parameter#PUBLIC PUBLIC
*/
public IntParam(String tag,
String desc,
int[] acceptableValues,
boolean optional,
boolean multiValued,
boolean hidden) {
this.setTag(tag);
this.setAcceptableIntValues(acceptableValues);
this.setDesc(desc);
this.setOptional(optional);
this.setMultiValued(multiValued);
this.setHidden(hidden);
this.setOptionLabel(DEFAULT_OPTION_LABEL);
}
/**
* Sets the minimum acceptable value for the parameter's value.
*
* If both acceptableValues and/or a minimum or maximum
* limit for the parameter value are specified, a valid value must
* satisfy all of the constraints.
*
* @param min the minimum acceptable value
* @throws IllegalArgumentException if min is
* greater than max
*/
public void setMin(int min) {
if (min > max) {
throw new IllegalArgumentException(Strings.get(
"IntParam.maxLessThanMin", new Object[] { tag }));
}
this.min = min;
}
/**
* Gets the value of the IntParam as in int. If the IntParam is
* multi-valued, only the first value is returned.
*
* @return the value as an int
* @throws RuntimeException if the value of the IntParam
* has not been set.
* @see Parameter#isSet()
*/
public int intValue() {
if (!set) {
throw new RuntimeException(Strings.get(
"IntParam.valueNotSet", new Object[] { tag }));
}
return Integer.parseInt((String)values.get(0));
}
/**
* Gets the values of the IntParam as an int array. Note that if the
* IntParam has no values, an empty array is returned.
*
* @return an array of int values
* @see Parameter#isSet()
*/
public int[] intValues() {
int[] vals = new int[values.size()];
for (int i = 0; i < vals.length; i++) {
vals[i] = Integer.parseInt((String)values.get(i));
}
return vals;
}
/**
* gets minimum acceptable value for the parameter's value
*
* @return the minimum acceptable value
*/
public int getMin() {
return min;
}
/**
* Sets the maximum acceptable value for the parameter.
*
* If both acceptableValues and/or a minimum or maximum
* limit for the parameter value are specified, a valid value must
* satisfy all of the constraints.
*
* @param max the maximum acceptable value
* @throws IllegalArgumentException if min is
* greater than max
*/
public void setMax(int max) {
if (min > max) {
throw new IllegalArgumentException(Strings.get(
"IntParam.maxLessThanMin", new Object[] { tag }));
}
this.max = max;
}
/**
* gets the maximum acceptable value for the parameter
*
* @return the maximum acceptable value
*/
public int getMax() {
return max;
}
/**
* Sets the acceptable values for this parameter.
*
* If both acceptableValues and/or a minimum or maximum
* limit for the parameter value are specified, a valid value must
* satisfy all of the constraints.
*
* @param acceptableValues An array of acceptable int values that
* the parameter's values must match. If null,
* the parameter's values can be any int.
*/
public void setAcceptableIntValues(int[] intValues) {
String[] sValues = new String[intValues.length];
for (int i = 0; i < intValues.length; i++) {
sValues[i] = Integer.toString(intValues[i]);
}
setAcceptableValues(sValues);
}
/**
* gets the acceptable values for this parameter
*
* @return The acceptable values for this parameter. If no
* acceptable values have been specified, this
* method returns null.
*/
public int[] getAcceptableIntValues() {
String[] sValues = getAcceptableValues();
int[] intValues = new int[sValues.length];
for (int i = 0; i < sValues.length; i++) {
intValues[i] = Integer.parseInt(sValues[i]);
}
return intValues;
}
/**
* Validates a prospective value with regards to the minimum and maximum
* values and the acceptableValues called by add/setValue(s)().
*
* @param val the prospective value to validate
* @throws CmdLineException if
* value is not valid with regard to
# the minimum and
* maximum values, and the acceptableValues.
*/
public void validateValue(String val) throws CmdLineException {
// Strip off any leading 0s before calling
// AbstractParameter.validateValue() because the Strings we sent
// as acceptable values were without.
int offset = 0;
while (val.startsWith("0", offset)) {
offset++;
}
super.validateValue(val.substring(offset));
CmdLineException exception = new CmdLineException(Strings.get(
"IntParam.validValues",
new Object[] { tag,
new Integer(min),
new Integer(max) }));
int intVal = 0;
try {
intVal = Integer.parseInt(val);
} catch (NumberFormatException e) {
throw exception;
}
if (intVal < min || intVal > max) {
throw exception;
}
}
}
pdfsam-1.1.4/jcmdline/src/java/jcmdline/StringParam.java 0000644 0001750 0001750 00000056570 10201471366 023116 0 ustar twerner twerner /*
* StringParam.java
*
* Classes:
* public StringParam
*
* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (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.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is the Java jcmdline (command line management) package.
*
* The Initial Developer of the Original Code is Lynne Lawrence.
*
* Portions created by the Initial Developer are Copyright (C) 2002
* the Initial Developer. All Rights Reserved.
*
* Contributor(s): Lynne Lawrence
*
* ***** END LICENSE BLOCK *****
*/
package jcmdline;
/**
* Encapsulate a command line parameter whose value will be a string.
*
* Usage:
*
* public class Sample {
* public static void main(String[] args) {
*
* // command line arguments
* StringParam patternArg =
* new StringParam("pattern", "the pattern to match",
* StringParam.REQUIRED);
* // other param definitions omitted
* .
* .
* CmdLineHandler cl =
* new VersionCmdLineHandler("V 5.2",
* new HelpCmdLineHandler(helpText,
* "kindagrep",
* "find lines in files containing a specified pattern",
* new Parameter[] { ignorecaseOpt, listfilesOpt },
* new Parameter[] { patternArg, filesArg } ));
* cl.parse(args);
* .
* .
* // don't need to check patternArg.isSet() because is REQUIRED
* String pattern = patternArg.getValue();
*
*
*
* @author Lynne Lawrence
* @version jcmdline Rel. @VERSION@ $Id: StringParam.java,v 1.3 2005/02/06 23:42:23 lglawrence Exp $
* @see CmdLineParser
*/
public class StringParam extends AbstractParameter {
/**
* the default label that will represent option values for this Parameter
* when displaying usage. The following demonstrates a possible usage
* excerpt for a StringParam option, where the option label is '<s>':
*
* suffix <s> Specifies the file suffix to use for all output files
* produced by this program.
*
* @see AbstractParameter#setOptionLabel(String) setOptionLabel()
* @see "StringParam.defaultOptionLabel in 'strings' properties file"
*/
public static final String DEFAULT_OPTION_LABEL =
Strings.get("StringParam.defaultOptionLabel");
/**
* the value of the minimum or maximum length if they have not been
* explicitly specified. This value may be compared with the results of
* getMinValLen() or getMaxValLen() to see whether a min/max had been
* set, but will cause an Exception to be thrown if passed to
* setMaxValLen() or setMinValLen().
*/
public static final int UNSPECIFIED_LENGTH = -1;
/**
* the maximum acceptable string length for the parameter value - if not
* specified, defaults to StringParam.UNSPECIFIED_LENGTH, which permits
* the value to be any length.
*/
protected int maxValLen = UNSPECIFIED_LENGTH;
/**
* the minimum acceptable string length for the parameter value - if not
* specified, defaults to 0.
*/
protected int minValLen = UNSPECIFIED_LENGTH;
/**
* constructor - creates single-valued, optional, parameter accepting a
* string value of any length
*
* @param tag a unique identifier for this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @throws IllegalArgumentException if tag
* or are invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
*/
public StringParam(String tag, String desc) {
this(tag, desc, 0, -1, OPTIONAL, SINGLE_VALUED, PUBLIC);
}
/**
* constructor - creates single-valued, parameter accepting a string value
* of any length, and either optional or required, as specified.
*
* @param tag a unique identifier for this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param optional {@link Parameter#OPTIONAL OPTIONAL} if
* optional,
* {@link Parameter#REQUIRED REQUIRED} if required
* @throws IllegalArgumentException if any of the specified
* parameters are invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
*/
public StringParam(String tag, String desc, boolean optional) {
this(tag, desc, 0, -1, optional, SINGLE_VALUED, PUBLIC);
}
/**
* constructor - creates a single-valued, optional, parameter accepting
* a value whose length is within the specified minimum and maximum lengths.
*
* @param tag a unique identifier for this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param minValLen the minimum acceptable length
* @param maxValLen the maximum acceptable length, or a negative number
* if there is no maximum length limit
* @throws IllegalArgumentException if any parameter is
* invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see #setMinValLen(int) setMinValLen()
* @see #setMaxValLen(int) setMaxValLen()
*/
public StringParam(String tag, String desc, int minValLen, int maxValLen) {
this(tag, desc, minValLen, maxValLen, OPTIONAL, SINGLE_VALUED, PUBLIC);
}
/**
* constructor - creates a single-valued, parameter accepting a value
* whose length is within the specified minimum and maximum lengths,
* and is optional or required, as specified.
*
* @param tag a unique identifier for this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param minValLen the minimum acceptable length
* @param maxValLen the maximum acceptable length, or a negative number
* if there is no maximum length limit
* @param optional {@link Parameter#OPTIONAL OPTIONAL} if
* optional,
* {@link Parameter#REQUIRED REQUIRED} if required
* @throws IllegalArgumentException if any parameter is
* invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see #setMinValLen(int) setMinValLen()
* @see #setMaxValLen(int) setMaxValLen()
* @see Parameter#OPTIONAL OPTIONAL
* @see Parameter#REQUIRED REQUIRED
*/
public StringParam(String tag,
String desc,
int minValLen,
int maxValLen,
boolean optional) {
this(tag, desc, minValLen, maxValLen, optional, SINGLE_VALUED, PUBLIC);
}
/**
* constructor - creates a single-valued, parameter accepting a value
* whose length is within the specified minimum and maximum lengths, and
* optional and/or multi-valued, as specified
*
* @param tag a unique identifier for this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param minValLen the minimum acceptable length
* @param maxValLen the maximum acceptable length, or a negative number
* if there is no maximum length limit
* @param optional {@link Parameter#OPTIONAL OPTIONAL} if
* optional,
* {@link Parameter#REQUIRED REQUIRED} if required
* @param multiValued {@link Parameter#MULTI_VALUED MULTI_VALUED} if
* the parameter can accept multiple values,
* {@link Parameter#SINGLE_VALUED SINGLE_VALUED}
* if the parameter can contain only a single value
* @throws IllegalArgumentException if any parameter is
* invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see #setMinValLen(int) setMinValLen()
* @see #setMaxValLen(int) setMaxValLen()
* @see Parameter#OPTIONAL OPTIONAL
* @see Parameter#REQUIRED REQUIRED
* @see Parameter#SINGLE_VALUED SINGLE_VALUED
* @see Parameter#MULTI_VALUED MULTI_VALUED
*/
public StringParam(String tag,
String desc,
int minValLen,
int maxValLen,
boolean optional,
boolean multiValued) {
this(tag, desc, minValLen, maxValLen, optional, multiValued, PUBLIC);
}
/**
* constructor - creates a single-valued, parameter accepting a value
* whose length is within the specified minimum and maximum lengths,
* with all other options specified.
*
* @param tag a unique identifier for this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param minValLen the minimum acceptable length
* @param maxValLen the maximum acceptable length, or a negative number
* if there is no maximum length limit
* @param optional {@link Parameter#OPTIONAL OPTIONAL} if
* optional,
* {@link Parameter#REQUIRED REQUIRED} if required
* @param multiValued {@link Parameter#MULTI_VALUED MULTI_VALUED} if
* the parameter can accept multiple values,
* {@link Parameter#SINGLE_VALUED SINGLE_VALUED}
* if the parameter can contain only a single value
* @param hidden {@link Parameter#HIDDEN HIDDEN} if parameter is
* not to be listed in the usage,
* {@link Parameter#PUBLIC PUBLIC} otherwise.
* @throws IllegalArgumentException if any parameter is
* invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see #setMinValLen(int) setMinValLen()
* @see #setMaxValLen(int) setMaxValLen()
* @see Parameter#OPTIONAL OPTIONAL
* @see Parameter#REQUIRED REQUIRED
* @see Parameter#SINGLE_VALUED SINGLE_VALUED
* @see Parameter#MULTI_VALUED MULTI_VALUED
* @see Parameter#HIDDEN HIDDEN
* @see Parameter#PUBLIC PUBLIC
*/
public StringParam(String tag,
String desc,
int minValLen,
int maxValLen,
boolean optional,
boolean multiValued,
boolean hidden) {
this.setTag(tag);
this.setMinValLen(minValLen);
if (maxValLen >= 0) {
this.setMaxValLen(maxValLen);
}
this.setDesc(desc);
this.optional = optional;
this.multiValued = multiValued;
this.hidden = hidden;
this.setOptionLabel(DEFAULT_OPTION_LABEL);
}
/**
* constructor - creates a single-valued, optional, string parameter whose
* value must be one of the specified values.
*
* @param tag the tag associated with this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param acceptableValues the acceptable values for the parameter
* @throws IllegalArgumentException if any parameter is
* invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see #setAcceptableValues(String[]) setAcceptableValues()
* @see #setMinValLen(int) setMinValLen()
*/
public StringParam(String tag, String desc, String[] acceptableValues) {
this(tag, desc, acceptableValues, OPTIONAL, SINGLE_VALUED, PUBLIC);
}
/**
* constructor - creates a single-valued, string parameter whose
* value must be a specified value, and which is optional
* or required, as specified.
*
* @param tag the tag associated with this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param acceptableValues the acceptable values for the parameter
* @param optional {@link Parameter#OPTIONAL OPTIONAL} if
* optional,
* {@link Parameter#REQUIRED REQUIRED} if required
* @throws IllegalArgumentException if any parameter is
* invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see #setAcceptableValues(String[]) setAcceptableValues()
* @see #setMinValLen(int) setMinValLen()
* @see Parameter#OPTIONAL OPTIONAL
* @see Parameter#REQUIRED REQUIRED
*/
public StringParam(String tag,
String desc,
String[] acceptableValues,
boolean optional) {
this(tag, desc, acceptableValues, optional, SINGLE_VALUED, PUBLIC);
}
/**
* constructor - creates a string parameter whose value must be a
* specified value and is optional and/or * multi-valued, as specified.
*
* @param tag the tag associated with this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param acceptableValues the acceptable values for the parameter
* @param optional {@link Parameter#OPTIONAL OPTIONAL} if
* optional,
* {@link Parameter#REQUIRED REQUIRED} if required
* @param multiValued {@link Parameter#MULTI_VALUED MULTI_VALUED} if
* the parameter can accept multiple values,
* {@link Parameter#SINGLE_VALUED SINGLE_VALUED}
* if the parameter can contain only a single value
* @throws IllegalArgumentException if any parameter is
* invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see #setAcceptableValues(String[]) setAcceptableValues()
* @see #setMinValLen(int) setMinValLen()
* @see Parameter#OPTIONAL OPTIONAL
* @see Parameter#REQUIRED REQUIRED
* @see Parameter#SINGLE_VALUED SINGLE_VALUED
* @see Parameter#MULTI_VALUED MULTI_VALUED
*/
public StringParam(String tag,
String desc,
String[] acceptableValues,
boolean optional,
boolean multiValued) {
this(tag, desc, acceptableValues, optional, multiValued, PUBLIC);
}
/**
* constructor - creates a string parameter whose value must be a
* specified value and all other options are as specified.
*
* @param tag the tag associated with this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param acceptableValues the acceptable values for the parameter
* @param optional {@link Parameter#OPTIONAL OPTIONAL} if
* optional,
* {@link Parameter#REQUIRED REQUIRED} if required
* @param multiValued {@link Parameter#MULTI_VALUED MULTI_VALUED} if
* the parameter can accept multiple values,
* {@link Parameter#SINGLE_VALUED SINGLE_VALUED}
* if the parameter can contain only a single value
* @param hidden {@link Parameter#HIDDEN HIDDEN} if parameter is
* not to be listed in the usage,
* {@link Parameter#PUBLIC PUBLIC} otherwise.
* @throws IllegalArgumentException if any parameter is
* invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see #setAcceptableValues(String[]) setAcceptableValues()
* @see #setMinValLen(int) setMinValLen()
* @see Parameter#OPTIONAL OPTIONAL
* @see Parameter#REQUIRED REQUIRED
* @see Parameter#SINGLE_VALUED SINGLE_VALUED
* @see Parameter#MULTI_VALUED MULTI_VALUED
* @see Parameter#HIDDEN HIDDEN
* @see Parameter#PUBLIC PUBLIC
*/
public StringParam(String tag,
String desc,
String[] acceptableValues,
boolean optional,
boolean multiValued,
boolean hidden) {
setTag(tag);
setDesc(desc);
setAcceptableValues(acceptableValues);
this.optional = optional;
this.multiValued = multiValued;
this.hidden = hidden;
this.setOptionLabel(DEFAULT_OPTION_LABEL);
}
/**
* Validates a prospective value with regards to the minimum and maximum
* values and the acceptableValues - called by add/setValue(s)().
*
* @param val the prospective value to validate
* @throws CmdLineException if
* value
* is not valid with regard to the minimum and
* maximum lengths, and the acceptableValues.
*/
public void validateValue(String val) throws CmdLineException {
super.validateValue(val);
if (minValLen != UNSPECIFIED_LENGTH && val.length() < minValLen) {
throw new CmdLineException(Strings.get(
"StringParam.valTooShort",
new Object[] { tag, new Integer(minValLen) }));
}
if (maxValLen != UNSPECIFIED_LENGTH && val.length() > maxValLen) {
throw new CmdLineException(Strings.get(
"StringParam.valTooLong",
new Object[] { tag, new Integer(maxValLen) }));
}
}
/**
* gets the value of the minimum acceptable length for the string value
*
* @return the minimum acceptable length for string value
* This will be equal to 0 if it had never been set.
*/
public int getMinValLen() {
return minValLen;
}
/**
* sets the value of the minimum acceptable length for the string value
*
* @param minValLen the minimum acceptable length
* @throws IllegalArgumentException if
* minValLen
* less than 0, or is greater than maxValLen
* .
*/
public void setMinValLen(int minValLen) {
if (minValLen < 0) {
throw new IllegalArgumentException(Strings.get(
"StringParam.minTooSmall", new Object[] { tag }));
}
if (maxValLen != UNSPECIFIED_LENGTH && minValLen > maxValLen) {
throw new IllegalArgumentException(Strings.get(
"StringParam.maxLessThanMin", new Object[] { tag }));
}
this.minValLen = minValLen;
}
/**
* gets the value of the maximum acceptable length for the string value
*
* @return The maximum acceptable length for string value.
* This will be equal to StingParam.UNSPECIFIED_LENGTH
* if it had never been set.
*/
public int getMaxValLen() {
return maxValLen;
}
/**
* sets the value of the maximum acceptable length for the string value
*
* @param maxValLen the maximum acceptable length
* @throws IllegalArgumentException if maxValLen
*
* less than 0, or is less than minValLen
* .
*/
public void setMaxValLen(int maxValLen) {
if (maxValLen < 0) {
throw new IllegalArgumentException(Strings.get(
"StringParam.maxTooSmall", new Object[] { tag }));
}
if (minValLen != UNSPECIFIED_LENGTH && maxValLen < minValLen) {
throw new IllegalArgumentException(Strings.get(
"StringParam.maxLessThanMin", new Object[] { tag }));
}
this.maxValLen = maxValLen;
}
/**
* sets the value of the maximum acceptable length for the string value
*
* @param maxValLen the maximum acceptable length
* @throws IllegalArgumentException if maxValLen
*
* less than 0, or is less than minValLen
* .
* @deprecated This method deprecated in favor of setMaxValLen(),
* which is more in line with the naming convetions
* used elsewhere in this class.
* @see #setMaxValLen(int) setMaxValLen()
*/
public void setMaxLength(int maxValLen) {
if (maxValLen < 0) {
throw new IllegalArgumentException(Strings.get(
"StringParam.maxTooSmall", new Object[] { tag }));
}
if (minValLen != UNSPECIFIED_LENGTH && maxValLen < minValLen) {
throw new IllegalArgumentException(Strings.get(
"StringParam.maxLessThanMin", new Object[] { tag }));
}
this.maxValLen = maxValLen;
}
}
pdfsam-1.1.4/jcmdline/src/java/jcmdline/Strings.java 0000644 0001750 0001750 00000007614 10201471366 022313 0 ustar twerner twerner /*
* Strings.java
*
* jcmdline Rel. @VERSION@ $Id: Strings.java,v 1.2 2002/12/07 14:22:06 lglawrence Exp $
*
* Classes:
* public Strings
*
* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (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.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is the Java jcmdline (command line management) package.
*
* The Initial Developer of the Original Code is Lynne Lawrence.
*
* Portions created by the Initial Developer are Copyright (C) 2002
* the Initial Developer. All Rights Reserved.
*
* Contributor(s): Lynne Lawrence
*
* ***** END LICENSE BLOCK *****
*/
package jcmdline;
import java.text.MessageFormat;
import java.util.ResourceBundle;
/**
* A helper class used to obtain Strings for this package. Strings are
* retrieved from the ResourceBundle in "jcmdline.strings" which may be
* localized as necessary.
*
* @author Lynne Lawrence
* @version jcmdline Rel. @VERSION@ $Id: Strings.java,v 1.2 2002/12/07 14:22:06 lglawrence Exp $
* @see java.util.ResourceBundle
*/
public class Strings {
/**
* The resource bundle for this package.
*/
private static final ResourceBundle rb =
ResourceBundle.getBundle("jcmdline.strings");
/**
* The String that prefaces return values when a key is not defined
* in the ResourceBundle. Note that this is checked for in the unit
* tests (see BetterTestCase) so a change in methodology here will
* require a change to the unit tests.
*/
private static final String missingKeyMsg =
rb.getString("Strings.missingKey") + " ";
/**
* Gets a String, filling in the supplied parameters.
*
* @param key the key with which to look up the String in the
* ResourceBundle
* @param params parameters to be plugged into the String
* @return The String, associated with key, with
* the supplied params plugged in as
* described for java.text.MessageFormat.
* Should key not exist in the
* ResourceBundle a String containing the key and a list
* of the parameters is returned.
* @see java.text.MessageFormat
* @see java.util.ResourceBundle
*/
public static String get(String key, Object[] params) {
String ret = missingKeyMsg + key;
try {
ret = rb.getString(key);
ret = MessageFormat.format(ret, params);
} catch (Exception e) {
ret += "; params: ";
for (int i = 0; i < params.length; i++) {
ret += "[" + params[i] + "] ";
}
}
return ret;
}
/**
* Gets a String.
*
* @param key the key with which to look up the String in the
* ResourceBundle
* @return The String, associated with key.
* Should key not exist in the
* ResourceBundle a String consisting of the key
* is returned.
* @see java.util.ResourceBundle
*/
public static String get(String key) {
String ret = missingKeyMsg + key;
try {
ret = rb.getString(key);
} catch (Exception e) {
// ignore - return the key
}
return ret;
}
}
pdfsam-1.1.4/jcmdline/src/java/jcmdline/PdfFileParam.java 0000644 0001750 0001750 00000046437 10724046170 023163 0 ustar twerner twerner /*
* PdfFileParam.java
*
* Classes:
* public FileParam
*
* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (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.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is the Java jcmdline (command line management) package.
*
* The Initial Developer of the Original Code is Lynne Lawrence.
*
* Portions created by the Initial Developer are Copyright (C) 2002
* the Initial Developer. All Rights Reserved.
*
* Contributor(s): Andrea Vacondio
*
* ***** END LICENSE BLOCK *****
*/
package jcmdline;
import java.io.File;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import jcmdline.dto.PdfFile;
/**
* Encapsulate a command line parameter whose value will be the name of
* a pdf document amd its password (Ex. file.pdf:pwd). Attributes, such as whether
* it must be readable, etc, may be specified and will be validated.
*
* Usage:
*
* public static void main(String[] args) {
*
* PdfFileParam filesArg =
* new PdfFileParam("file",
* "a file to be processed - defaults to stdin",
* PdfFileParam.IS_READABLE,
* PdfFileParam.OPTIONAL,
* PdfFileParam.MULTI_VALUED);
*
*
* }
*
*
* @author Andrea Vacondio
* @version jcmdline Rel. @VERSION@ $Id: PdfFileParam.java
* @see CmdLineParser
*/
public class PdfFileParam extends AbstractParameter {
// Note: attributes are specified with kind of a "reverse map" so
// that they can be "ANDed" together when set, which is more natural
// since that is the way they are processed.
/**
* indicates that no file/dir attributes are required or will be checked
* @see #setAttributes(int) setAttributes()
*/
public static final int NO_ATTRIBUTES = 0xffff;
/**
* indicates that a file specified as a value for this
* PdfFileParam must exist
* @see #setAttributes(int) setAttributes()
*/
public static final int EXISTS = 0xfffe;
/**
* indicates that a value specified for this PdfFileParam must name an
* existing file for which the caller has read access
* @see #setAttributes(int) setAttributes()
*/
public static final int IS_READABLE = 0xffef;
/**
* indicates that a value specified for this PdfFileParam must name an
* existing file for which the caller has write access
* @see #setAttributes(int) setAttributes()
*/
public static final int IS_WRITEABLE = 0xffdf;
/**
* the default label that will represent option values for this Parameter.
* The following demonstrates a possible usage for a PdfFileParam option,
* where the option label is '<file>':
*
* out <file> the output file
*
* @see AbstractParameter#setOptionLabel(String) setOptionLabel()
* @see "PdfFileParam.defaultFileOptionLabel in 'strings' properties
* file"
*/
public static final String DEFAULT_FILE_OPTION_LABEL =
Strings.get("PdfFileParam.defaultFileOptionLabel");
/**
* Attributes which a file/directory value must have
* @see #setAttributes(int) setAttributes()
* @see #getAttributes()
*/
private int attributes;
/**
* constructor - creates single-valued, optional, public parameter
* which accepts any valid file name as its value
*
* @param tag a unique identifier for this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @throws IllegalArgumentException if tag
* or are invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
*/
public PdfFileParam(String tag, String desc) {
this(tag, desc, NO_ATTRIBUTES, OPTIONAL, SINGLE_VALUED, PUBLIC);
}
/**
* constructor - creates single-valued, public parameter which accepts
* any valid file name as its value and is optional or
* required, as specified.
*
* @param tag a unique identifier for this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param optional {@link Parameter#OPTIONAL OPTIONAL} if
* optional,
* {@link Parameter#REQUIRED REQUIRED} if required
* @throws IllegalArgumentException if any of the specified
* parameters are invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see Parameter#OPTIONAL OPTIONAL
* @see Parameter#REQUIRED REQUIRED
*/
public PdfFileParam(String tag, String desc, boolean optional) {
this(tag, desc, NO_ATTRIBUTES, optional, SINGLE_VALUED, PUBLIC);
}
/**
* constructor - creates a single-valued, optional, public, parameter
* accepts a file name with the specified attributes.
*
* @param tag a unique identifier for this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param attributes the attributes that must apply to a file or
* directory specified as a value to this FileParam
* @throws IllegalArgumentException if any parameter is
* invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see #setAttributes(int) setAttributes()
*/
public PdfFileParam(String tag, String desc, int attributes) {
this(tag, desc, attributes, OPTIONAL, SINGLE_VALUED, PUBLIC);
}
/**
* constructor - creates a single-valued, public, parameter
* that accepts a file name with the specified attributes,
* and which is required or optional, as specified.
*
* @param tag a unique identifier for this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param attributes the attributes that must apply to a file or
* directory specified as a value to this FileParam
* @param optional {@link Parameter#OPTIONAL OPTIONAL} if
* optional,
* {@link Parameter#REQUIRED REQUIRED} if required
* @throws IllegalArgumentException if any parameter is
* invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see #setAttributes(int) setAttributes()
* @see Parameter#OPTIONAL OPTIONAL
* @see Parameter#REQUIRED REQUIRED
*/
public PdfFileParam(String tag,
String desc,
int attributes,
boolean optional) {
this(tag, desc, attributes, optional, SINGLE_VALUED, PUBLIC);
}
/**
* constructor - creates a public parameter that accepts a file
* name with the specified attributes, and which is required
* or optional and/or multi-valued, as specified.
*
* @param tag a unique identifier for this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param attributes the attributes that must apply to a file or
* directory specified as a value to this FileParam
* @param optional {@link Parameter#OPTIONAL OPTIONAL} if
* optional,
* {@link Parameter#REQUIRED REQUIRED} if required
* @param multiValued {@link Parameter#MULTI_VALUED MULTI_VALUED} if
* the parameter can accept multiple values,
* {@link Parameter#SINGLE_VALUED SINGLE_VALUED}
* if the parameter can contain only a single value
* @throws IllegalArgumentException if any parameter is
* invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see #setAttributes(int) setAttributes()
* @see Parameter#OPTIONAL OPTIONAL
* @see Parameter#REQUIRED REQUIRED
* @see Parameter#SINGLE_VALUED SINGLE_VALUED
* @see Parameter#MULTI_VALUED MULTI_VALUED
*/
public PdfFileParam(String tag,
String desc,
int attributes,
boolean optional,
boolean multiValued) {
this(tag, desc, attributes, optional, multiValued, PUBLIC);
}
/**
* constructor - creates a parameter that accepts a file
* name with the specified attributes, and which is required or optional
* and/or multi-valued or hidden, as specified.
*
* If the IS_DIR attribute is specified, the option label for
* this FileParam will be set to {@link #DEFAULT_DIR_OPTION_LABEL},
* else it will be {@link #DEFAULT_FILE_OPTION_LABEL}.
*
* @param tag a unique identifier for this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param attributes the attributes that must apply to a file or
* directory specified as a value to this FileParam
* @param optional {@link Parameter#OPTIONAL OPTIONAL} if
* optional,
* {@link Parameter#REQUIRED REQUIRED} if required
* @param multiValued {@link Parameter#MULTI_VALUED MULTI_VALUED} if
* the parameter can accept multiple values,
* {@link Parameter#SINGLE_VALUED SINGLE_VALUED}
* if the parameter can contain only a single value
* @param hidden {@link Parameter#HIDDEN HIDDEN} if parameter is
* not to be listed in the usage,
* {@link Parameter#PUBLIC PUBLIC} otherwise.
* @throws IllegalArgumentException if any parameter is
* invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see AbstractParameter#setOptionLabel(String) setOptionLabel()
* @see #setAttributes(int) setAttributes()
* @see Parameter#OPTIONAL OPTIONAL
* @see Parameter#REQUIRED REQUIRED
* @see Parameter#SINGLE_VALUED SINGLE_VALUED
* @see Parameter#MULTI_VALUED MULTI_VALUED
* @see Parameter#HIDDEN HIDDEN
* @see Parameter#PUBLIC PUBLIC
*/
public PdfFileParam(String tag,
String desc,
int attributes,
boolean optional,
boolean multiValued,
boolean hidden) {
this.setTag(tag);
this.setAttributes(attributes);
this.setDesc(desc);
this.optional = optional;
this.multiValued = multiValued;
this.hidden = hidden;
this.setOptionLabel(DEFAULT_FILE_OPTION_LABEL);
}
/**
* Gets the value of the PdfFileParam as a PdfFileParam object. If the PdfFileParam is
* multi-valued, the first value is returned.
*
* @return the value as a PdfFile object
* @throws RuntimeException if the value of the FileParam
* has not been set.
* @see Parameter#isSet()
*/
public PdfFile getPdfFile() {
PdfFile retVal = null;
if (!set) {
throw new RuntimeException(Strings.get(
"PdfFileParam.valueNotSet", new Object[] { tag }));
}
retVal = getPdfFile((String)values.get(0));
return retVal;
}
/**
* Gets the values of the PdfFileParam as a Collection of PdfFile objects.
* If the PdfFileParam has no values, an empty Collection is returned.
*
* @return a Collection of PdfFile objects, possibly empty
* @see Parameter#isSet()
*/
public Collection getPdfFiles() {
ArrayList vals = new ArrayList(values.size());
for (Iterator itr = values.iterator(); itr.hasNext(); ) {
vals.add(getPdfFile((String)itr.next()));
}
return vals;
}
/**
* Validates a prospective value for the PdfFileParam - called by
* add/setValue(s)(). All of the attributes are validated and the a
* CmdLineException is thrown if any are not satisfied.
*
* @param val the value to validate
* @throws CmdLineException if value is not valid.
* @see #setAttributes(int) setAttributes()
*/
public void validateValue(String val) throws CmdLineException {
super.validateValue(val);
PdfFile f = null;
try {
f = getPdfFile(val);
} catch (Exception e) {
throwIllegalValueException(val);
}
if (attrSpecified(EXISTS) && !f.getFile().exists()) {
throwIllegalValueException(val);
}
if (attrSpecified(IS_READABLE) && !f.getFile().canRead()) {
throwIllegalValueException(val);
}
if (attrSpecified(IS_WRITEABLE) && !f.getFile().canWrite()) {
throwIllegalValueException(val);
}
}
/**
* Indicates whether an attribute has been specified for this FileParam.
*
* @param attr one of {@link #NO_ATTRIBUTES}, {@link #EXISTS},
* {@link #IS_READABLE}, or
* {@link #IS_WRITEABLE}
* @return true if the attribute is set,
* false if the attribute is not set or
* attr is not a valid attribute
*/
public boolean attrSpecified(int attr) {
if (!(attr == EXISTS ||
attr == NO_ATTRIBUTES ||
attr == IS_READABLE ||
attr == IS_WRITEABLE)) {
return false;
}
return (((attributes | attr) ^ 0xffff) != 0);
}
/**
* Sets the value of attributes. Multiple attributes may be specified
* by ANDing them together. If multiple attributes are specified,
* all conditions must be met for a parameter value to be considered
* valid. For example:
*
* FileParam fp = new FileParam("tempDir",
* "a directory in which temporary files can be stored",
* FileParam.IS_DIR & FileParam.IS_WRITEABLE);
*
* In this case, a valid parameter value would have to be both a
* directory and writeable.
*
* Specify NO_ATTRIBUTES if none of the other attributes is
* required.
*
* @param attributes a combination of {@link #NO_ATTRIBUTES},
* {@link #EXISTS},
* {@link #IS_READABLE}, and {@link #IS_WRITEABLE}
* @throws IllegalArgumentException if the attributes value
* is invalid.
* @see #getAttributes()
*/
public void setAttributes(int attributes) {
if ((attributes ^ 0xffff) >= ((IS_WRITEABLE ^ 0xffff) * 2)) {
throw new IllegalArgumentException(Strings.get(
"PdfFileParam.invalidAttributes",
new Object[] { new Integer(attributes) }));
}
this.attributes = attributes;
}
/**
* gets the value of attributes
*
* @return The attributes specified for this FileParam
* @see #setAttributes(int) setAttributes()
*/
public int getAttributes() {
return attributes;
}
/**
* Throws a nicely formatted error message when an invalid value is
* attempted to be validated.
*
* @param val the value that failed validation
* @return doesn't - throws a CmdLineException
* @throws CmdLineException - that's its goal!
*/
private void throwIllegalValueException (String val)
throws CmdLineException {
String s1 = Strings.get("FileParam.file");
String s2;
if (attrSpecified(EXISTS) ||
attrSpecified(IS_READABLE) ||
attrSpecified(IS_WRITEABLE)) {
s2 = Strings.get("PdfFileParam.an_existing");
} else {
s2 = Strings.get("PdfFileParam.a");
}
String s3 = "";
if (attrSpecified(IS_READABLE)) {
if (attrSpecified(IS_WRITEABLE)) {
s3 = Strings.get("FileParam.readable_writeable");
} else {
s3 = Strings.get("PdfFileParam.readable");
}
} else if (attrSpecified(IS_WRITEABLE)) {
s3 = Strings.get("PdfFileParam.writeable");
}
throw new CmdLineException(Strings.get(
"PdfFileParam.illegalValue",new Object[] { s2, s1, s3, val, tag }));
}
/**
* @param value
* @return the PdfFile
*/
private PdfFile getPdfFile(String value){
PdfFile retVal = null;
int k = value.toLowerCase().lastIndexOf(".pdf:");
if (k < 0){
retVal = new PdfFile(new File(value),"");
}else{
retVal = new PdfFile(new File(value.substring(0, k+4)),value.substring(k+5, value.length()));
}
return retVal;
}
}
pdfsam-1.1.4/jcmdline/src/java/jcmdline/LoggerCmdLineHandler.java 0000644 0001750 0001750 00000025446 10201471366 024636 0 ustar twerner twerner /*
* LoggerCmdLineHandler.java
*
* Classes:
* public LoggerCmdLineHandler
*
* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (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.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is the Java jcmdline (command line management) package.
*
* The Initial Developer of the Original Code is Lynne Lawrence.
*
* Portions created by the Initial Developer are Copyright (C) 2002
* the Initial Developer. All Rights Reserved.
*
* Contributor(s): Lynne Lawrence
*
* ***** END LICENSE BLOCK *****
*/
package jcmdline;
import java.io.OutputStream;
import java.util.Collection;
import java.util.logging.Formatter;
import java.util.logging.Handler;
import java.util.logging.Level;
import java.util.logging.Logger;
import java.util.logging.SimpleFormatter;
import java.util.logging.StreamHandler;
/**
* A CmdLineHandler Decorator class that implements a logging option that
* implements rudimentary support for the java.util.logging package.
*
* The implemented option is a StringParam whose tag is defined by
* "LoggerCmdLineHandler.logOpt.tag" in the strings.properties
* file (set to "log", in English).
* The acceptable values for the parameter are set to the localized
* strings that are valid logging levels as defined by the
* java.util.logging.Level class.
*
* Should the user set this option
* a StreamHandler is added to the root logger and the
* logging level of the root logger and the StreamHandler are set
* to that specified on the command line. It is possible to set a
* Formatter for the log messages (the default is
* java.util.logging.SimpleFormatter) with the
* {@link #setLogFormatter(Formatter) setLogFormatter()} method.
* This method, if used, must be called prior to any calls to
* parse().
*
* Information on using CmdLineHandlers can be found in the jcmdline
* User Guide.
*
* @author Lynne Lawrence
* @version jcmdline Rel. @VERSION@ $Id: LoggerCmdLineHandler.java,v 1.2 2002/12/07 14:22:06 lglawrence Exp $
* @see CmdLineHandler
* @see AbstractHandlerDecorator
* @see java.util.logging.Logger
*/
public class LoggerCmdLineHandler extends AbstractHandlerDecorator {
/**
* a parameter that will cause the root logger level to be set
*/
private Parameter logOpt;
/**
* the OutputStream to which to write log messages
*/
private OutputStream stream;
/**
* the formatter for log messages, defaults to
* java.util.logging.SimpleFormatter
* @see #setLogFormatter(Formatter) setLogFormatter()
* @see #getLogFormatter()
*/
private Formatter logFormatter;
/**
* constructor
*
* @param stream the OutputStream to which to write log messages
* @param handler the CmdLineHandler to which most functionality
* will be delegated
* @throws IllegalArgumentException if stream is null
*/
public LoggerCmdLineHandler (OutputStream stream, CmdLineHandler handler) {
super(handler);
if (stream == null) {
throw new IllegalArgumentException(Strings.get(
"LoggerCmdLineHandler.streamNullError"));
}
this.stream = stream;
String[] validVals = new String[] {
Level.ALL.getLocalizedName(),
Level.OFF.getLocalizedName(),
Level.FINEST.getLocalizedName(),
Level.FINER.getLocalizedName(),
Level.FINE.getLocalizedName(),
Level.CONFIG.getLocalizedName(),
Level.INFO.getLocalizedName(),
Level.WARNING.getLocalizedName(),
Level.SEVERE.getLocalizedName()};
logFormatter = new SimpleFormatter();
logOpt = new StringParam(
Strings.get("LoggerCmdLineHandler.logOpt.tag"),
Strings.get("LoggerCmdLineHandler.logOpt.desc", validVals),
validVals,
Parameter.OPTIONAL);
setCustomOptions(new Parameter[] { logOpt });
}
/**
* constructor - creates a new DefaultCmdLineHandler as its delegate
*
* @param stream the OutputStream to which to write log messages
* @param cmdName the name of the command
* @param cmdDesc a short description of the command
* @param options a collection of Parameter objects, describing the
* command's command-line options
* @param args a collection of Parameter objects, describing the
* command's command-line arguments (what is left on
* the command line after all options and their
* parameters have been processed)
* @param parser a CmdLineParser to be used to parse the command line
* @throws IllegalArgumentException if any of the
* parameters are not correctly specified.
* @see DefaultCmdLineHandler
*/
public LoggerCmdLineHandler ( OutputStream stream,
String cmdName,
String cmdDesc,
Parameter[] options,
Parameter[] args,
CmdLineParser parser) {
this(stream, new DefaultCmdLineHandler(
cmdName, cmdDesc, options, args, parser));
}
/**
* constructor - creates a new DefaultCmdLineHandler as its delegate
*
* @param stream the OutputStream to which to write log messages
* @param cmdName the name of the command
* @param cmdDesc a short description of the command
* @param options a collection of Parameter objects, describing the
* command's command-line options
* @param args a collection of Parameter objects, describing the
* command's command-line arguments (what is left on
* the command line after all options and their
* parameters have been processed)
* @throws IllegalArgumentException if any of the
* parameters are not correctly specified.
* @see DefaultCmdLineHandler
*/
public LoggerCmdLineHandler ( OutputStream stream,
String cmdName,
String cmdDesc,
Parameter[] options,
Parameter[] args) {
this(stream,
new DefaultCmdLineHandler(cmdName, cmdDesc, options, args));
}
/**
* constructor - uses the PosixCmdLineParser to parse the command line
*
* @param stream the OutputStream to which to write log messages
* @param cmdName the name of the command creating this
* DefaultCmdLineHandler
* @param cmdDesc a short description of the command's purpose
* @param options a collection of Parameter objects, describing the
* command's command-line options
* @param args a collection of Parameter objects, describing the
* command's command-line arguments (what is left on
* the command line after all options and their
* parameters have been processed)
* @throws IllegalArgumentException if any of the
* parameters are not correctly specified.
* @see #setCmdName(String) setCmdName()
* @see #setCmdDesc(String) setCmdDesc()
* @see #setOptions(Parameter[]) setOptions()
* @see PosixCmdLineParser
*/
public LoggerCmdLineHandler ( OutputStream stream,
String cmdName,
String cmdDesc,
Collection options,
Collection args) {
this(stream,
new DefaultCmdLineHandler(cmdName, cmdDesc, options, args));
}
/**
* Called following the call to parse() of this class's
* contained CmdLineHandler. This method only checks for its option if
* parseStatus is true.
*
* This method adds a ConsoleHandler to the root logger and sets the
* logging level of the root logger to that specified on the command line.
*
* @param parseStatus The result of the parse() call to this
* class's contained CmdLineHandler.
* @return This method will call System.exit(0), rather
* than returning, if its option is set.
* Otherwise, parseStatus is returned.
*/
protected boolean processParsedOptions(boolean parseOk) {
if (parseOk) {
if (logOpt.isSet()) {
Level level = Level.parse(logOpt.getValue());
Handler h = new StreamHandler(stream, logFormatter);
h.setLevel(level);
Logger rootLogger = Logger.getLogger("");
rootLogger.addHandler(h);
rootLogger.setLevel(level);
}
}
return parseOk;
}
/**
* Sets the formatter for log messages, defaults to
* java.util.logging.SimpleFormatter. This method must be
* called prior to calling parse() - calling this method after
* the command line has been parsed will have no effect.
*
* @param logFormatter the formatter for log messages
* @throws IllegalArgumentException if logFormatter is null
* @see #getLogFormatter()
*/
public void setLogFormatter(Formatter logFormatter) {
if (logFormatter == null) {
throw new IllegalArgumentException(Strings.get(
"LoggerCmdLineHandler.logFormatterNullError"));
}
this.logFormatter = logFormatter;
}
/**
* Gets the formatter for log messages, defaults to
* java.util.logging.SimpleFormatter.
*
* @return the formatter for log messages
* @see #setLogFormatter(Formatter) setLogFormatter()
*/
public Formatter getLogFormatter() {
return logFormatter;
}
}
pdfsam-1.1.4/jcmdline/src/java/jcmdline/CmdLineException.java 0000644 0001750 0001750 00000005602 10722536300 024045 0 ustar twerner twerner /*
* CmdLineException.java
*
* Classes:
* public CmdLineException
*
* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (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.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is the Java jcmdline (command line management) package.
*
* The Initial Developer of the Original Code is Lynne Lawrence.
*
* Portions created by the Initial Developer are Copyright (C) 2002
* the Initial Developer. All Rights Reserved.
*
* Contributor(s): Lynne Lawrence
*
* ***** END LICENSE BLOCK *****
*/
package jcmdline;
import java.text.MessageFormat;
/**
* An Exception that indicates a command line processing error.
*
* Sample Usage:
*
* To use this for an exception in package 'mypackage',
* a properties file called 'errors.properties' might be created in
* directory 'mypackage' with the following properties:
*
* # Contents of errors.properties file
*
* PercentTooLow: \
* Percent must be greater than {0}, got {1}.
*
* PercentTooHigh: \
* Percent must be less than {0}, got {1}.
*
*
* Throwing an exception would be done as in the following:
*
* if (percent > 100) {
* ResourceBundle rb = ResourceBundle.getBundle("mypackage.errors");
* String msg = rb.getString("PercentTooHigh");
* throw new CmdLineException(msg,
* new Object[] { new Integer(100),
* new Integer(percent) });
* }
*
*
* The package may now be modified to accomodate a French Locale by creating
* a file 'errors_fr.properties' in directory 'mypackage' that contains all
* messages in 'errors.properties', converted to French.
*
* @author Lynne Lawrence
* @version jcmdline Rel. @VERSION@ $Id: CmdLineException.java,v 1.2 2002/12/07 14:22:06 lglawrence Exp $
*/
public class CmdLineException extends Exception {
private static final long serialVersionUID = 7450308469367315829L;
/**
* constructor
*
* @param message message associated with the exception
*/
public CmdLineException(String message) {
super(message);
}
/**
* constructor
*
* @param message message associated with the exception
* @param params parameters to be plugged into message
*/
public CmdLineException(String message, Object[] params) {
super(MessageFormat.format(message, params));
}
}
pdfsam-1.1.4/jcmdline/src/java/jcmdline/TimeParam.java 0000644 0001750 0001750 00000066675 10722536036 022561 0 ustar twerner twerner /*
* TimeParam.java
*
* jcmdline Rel. @VERSION@ $Id: TimeParam.java,v 1.2 2002/12/07 14:22:06 lglawrence Exp $
*
* Classes:
* public TimeParam
*
* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (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.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is the Java jcmdline (command line management) package.
*
* The Initial Developer of the Original Code is Lynne Lawrence.
*
* Portions created by the Initial Developer are Copyright (C) 2002
* the Initial Developer. All Rights Reserved.
*
* Contributor(s): Lynne Lawrence
*
* ***** END LICENSE BLOCK *****
*/
package jcmdline;
import java.text.DecimalFormat;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Collection;
import java.util.Date;
import java.util.Iterator;
/**
* A parameter that accepts a time as its value.
*
* The format for the time is "HH:mm:ss:SSS", where
* the seconds and/or milliseconds portion may be left off by the user,
* in which case they will be defaulted.
*
* Sample Usage:
*
* TimeParam startTimeParam =
* new TimeParam("startTime",
* "start time of report",
* TimeParam.REQUIRED);
* TimeParam endTimeParam =
* new TimeParam("endTime",
* "end time of report",
* TimeParam.REQUIRED);
*
* // Seconds and millis for startTime will both be 0 by default.
* // Set the seconds and millis for the end of the report to be the end
* // of a minute.
* endTimeParam.setDefaultSeconds(59);
* endTimeParam.setDefaultMilliSeconds(999);
*
* CmdLineHandler cl = new DefaultCmdLineHandler(
* "myreport", "generate current activity report",
* new Parameter[] {},
* new Parameter[] { startTimeParam, endTimeParam });
*
* cl.parse();
*
* // Don't need to check isSet() because params are REQUIRED
* Date today = new Date();
* Date stTime = startTimeParam.getDate(today);
* Date enTime = endTimeParam.getDate(today);
* .
* .
*
* This will result in a command line that may be executed as:
*
* myreport "10:12" "23:34"
*
* or
*
* myreport "10:12:34:567" "23:34:34:567"
*
*
* @author Lynne Lawrence
* @version jcmdline Rel. @VERSION@ $Id: TimeParam.java,v 1.2 2002/12/07 14:22:06 lglawrence Exp $
* @see DateParam
* @see TimeParam
*/
public class TimeParam extends AbstractParameter {
private static final String sTimeFmt = "HH:mm:ss:SSS";
private static final String sTimeFmtDisplay = "HH:mm[:ss[:SSS]]";
private static final DecimalFormat secondFmt = new DecimalFormat("00");
private static final DecimalFormat msFmt = new DecimalFormat("000");
private static final long MILLIS_PER_SECOND = 1000;
private static final long MILLIS_PER_MINUTE = MILLIS_PER_SECOND * 60;
private static final long MILLIS_PER_HOUR = MILLIS_PER_MINUTE * 60;
/**
* The seconds default to use if not specified by the user.
* This will default to 0 if never specified for a TimeParam object.
* @see #setDefaultSeconds(int) setDefaultSeconds()
* @see #getDefaultSeconds()
*/
private int defaultSeconds = 0;
/**
* The default millisecond value to use if not specified by the user.
* This will default to 0 if never specified for a TimeParam object.
* @see #setDefaultMilliSeconds(int) setDefaultMilliSeconds()
* @see #getDefaultMilliSeconds()
*/
private int defaultMilliSeconds = 0;
/**
* An array of acceptable time values. We are bypassing the superclass
* acceptable values implementation altogether because we do an
* "approximate" time match using default seconds and milliseconds
* at the time of the parse.
*/
private String[] acceptableTimes = null;
/**
* constructor - creates single-valued, optional, public
* parameter
*
* @param tag a unique identifier for this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @throws IllegalArgumentException if tag
* or are invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
*/
public TimeParam(String tag, String desc) {
this(tag, desc, OPTIONAL, SINGLE_VALUED, PUBLIC);
}
/**
* constructor - creates single-valued, public parameter which will
* will be either optional or required, as specified.
*
* @param tag a unique identifier for this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param optional {@link Parameter#OPTIONAL OPTIONAL} if
* optional,
* {@link Parameter#REQUIRED REQUIRED} if required
* @throws IllegalArgumentException if any of the specified
* parameters are invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
*/
public TimeParam(String tag, String desc, boolean optional) {
this(tag, desc, optional, SINGLE_VALUED, PUBLIC);
}
/**
* constructor - creates a public parameter which will
* will be either optional or required, and/or multi-valued, as specified.
*
* @param tag a unique identifier for this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param optional {@link Parameter#OPTIONAL OPTIONAL} if
* optional,
* {@link Parameter#REQUIRED REQUIRED} if required
* @param multiValued {@link Parameter#MULTI_VALUED MULTI_VALUED} if
* the parameter can accept multiple values,
* {@link Parameter#SINGLE_VALUED SINGLE_VALUED}
* if the parameter can contain only a single value
* @throws IllegalArgumentException if any of the specified
* parameters are invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see Parameter#SINGLE_VALUED SINGLE_VALUED
* @see Parameter#MULTI_VALUED MULTI_VALUED
*/
public TimeParam(String tag,
String desc,
boolean optional,
boolean multiValued) {
this(tag, desc, optional, multiValued, PUBLIC);
}
/**
* constructor - creates a parameter which will
* will be either optional or required, single or multi-valued, and
* hidden or public as specified.
*
* @param tag a unique identifier for this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param optional {@link Parameter#OPTIONAL OPTIONAL} if
* optional,
* {@link Parameter#REQUIRED REQUIRED} if required
* @param multiValued {@link Parameter#MULTI_VALUED MULTI_VALUED} if
* the parameter can accept multiple values,
* {@link Parameter#SINGLE_VALUED SINGLE_VALUED}
* if the parameter can contain only a single value
* @param hidden {@link Parameter#HIDDEN HIDDEN} if parameter is
* not to be listed in the usage,
* {@link Parameter#PUBLIC PUBLIC} otherwise.
* @throws IllegalArgumentException if any of the specified
* parameters are invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see Parameter#SINGLE_VALUED SINGLE_VALUED
* @see Parameter#MULTI_VALUED MULTI_VALUED
* @see Parameter#HIDDEN HIDDEN
* @see Parameter#PUBLIC PUBLIC
*/
public TimeParam(String tag,
String desc,
boolean optional,
boolean multiValued,
boolean hidden) {
this.setTag(tag);
this.setDesc(desc);
this.setOptional(optional);
this.setMultiValued(multiValued);
this.setHidden(hidden);
this.setOptionLabel(sTimeFmtDisplay);
}
/**
* constructor - creates a single-valued, optional, public,
* number parameter whose value must be one of the specified values.
*
* @param tag the tag associated with this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param acceptableValues the acceptable values for the parameter
* @throws IllegalArgumentException if any parameter is
* invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see #setAcceptableValues(String[]) setAcceptableValues()
*/
public TimeParam(String tag, String desc, String[] acceptableValues) {
this(tag, desc, acceptableValues, OPTIONAL, SINGLE_VALUED, PUBLIC);
}
/**
* constructor - creates a single-valued, public,
* number parameter whose value must be one of the specified values,
* and which is required or optional, as specified.
*
* @param tag the tag associated with this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param acceptableValues the acceptable values for the parameter
* @param optional {@link Parameter#OPTIONAL OPTIONAL} if
* optional,
* {@link Parameter#REQUIRED REQUIRED} if required
* @throws IllegalArgumentException if any parameter is
* invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see #setAcceptableValues(String[]) setAcceptableValues()
* @see Parameter#OPTIONAL OPTIONAL
* @see Parameter#REQUIRED REQUIRED
*/
public TimeParam(String tag,
String desc,
String[] acceptableValues,
boolean optional) {
this(tag, desc, acceptableValues, optional, SINGLE_VALUED, PUBLIC);
}
/**
* constructor - creates a public
* number parameter whose value must be one of the specified values,
* and which is required or optional and/or multi-valued, as specified.
*
* @param tag the tag associated with this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param acceptableValues the acceptable values for the parameter
* @param optional {@link Parameter#OPTIONAL OPTIONAL} if
* optional,
* {@link Parameter#REQUIRED REQUIRED} if required
* @param multiValued {@link Parameter#MULTI_VALUED MULTI_VALUED} if
* the parameter can accept multiple values,
* {@link Parameter#SINGLE_VALUED SINGLE_VALUED}
* if the parameter can contain only a single value
* @throws IllegalArgumentException if any parameter is
* invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see #setAcceptableValues(String[]) setAcceptableValues()
* @see Parameter#OPTIONAL OPTIONAL
* @see Parameter#REQUIRED REQUIRED
* @see Parameter#SINGLE_VALUED SINGLE_VALUED
* @see Parameter#MULTI_VALUED MULTI_VALUED
*/
public TimeParam(String tag,
String desc,
String[] acceptableValues,
boolean optional,
boolean multiValued) {
this(tag, desc, acceptableValues, optional, multiValued, PUBLIC);
}
/**
* constructor - creates a
* Parameter, all of whose options are specified.
*
* @param tag the tag associated with this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param acceptableValues the acceptable values for the parameter
* @param optional {@link Parameter#OPTIONAL OPTIONAL} if
* optional,
* {@link Parameter#REQUIRED REQUIRED} if required
* @param multiValued {@link Parameter#MULTI_VALUED MULTI_VALUED} if
* the parameter can accept multiple values,
* {@link Parameter#SINGLE_VALUED SINGLE_VALUED}
* if the parameter can contain only a single value
* @param hidden {@link Parameter#HIDDEN HIDDEN} if parameter is
* not to be listed in the usage,
* {@link Parameter#PUBLIC PUBLIC} otherwise.
* @throws IllegalArgumentException if any parameter is
* invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see #setAcceptableValues(String[]) setAcceptableValues()
* @see Parameter#OPTIONAL OPTIONAL
* @see Parameter#REQUIRED REQUIRED
* @see Parameter#SINGLE_VALUED SINGLE_VALUED
* @see Parameter#MULTI_VALUED MULTI_VALUED
* @see Parameter#HIDDEN HIDDEN
* @see Parameter#PUBLIC PUBLIC
*/
public TimeParam(String tag,
String desc,
String[] acceptableValues,
boolean optional,
boolean multiValued,
boolean hidden) {
this.setTag(tag);
this.setAcceptableValues(acceptableValues);
this.setDesc(desc);
this.setOptional(optional);
this.setMultiValued(multiValued);
this.setHidden(hidden);
this.setOptionLabel(sTimeFmtDisplay);
}
/**
* Verifies that value is valid for this entity - called by
* add/setValue(s)().
*
* @param value the value to be validated
* @throws CmdLineException if value is not valid.
*/
public void validateValue(String val) throws CmdLineException {
super.validateValue(val);
String fullval = fullTime(val);
if (acceptableTimes != null) {
for (int i = 0; i < acceptableTimes.length; i++) {
if (fullval.equals(fullTime(acceptableTimes[i]))) {
return;
}
}
int maxExpectedAVLen = 200;
StringBuffer b = new StringBuffer(maxExpectedAVLen);
for (int i = 0; i < acceptableTimes.length; i++) {
b.append("\n " + acceptableTimes[i]);
}
throw new CmdLineException(Strings.get(
"Parameter.valNotAcceptableVal",
new Object[] { val, tag, b.toString() }));
}
try {
if (fullval.length() > 12) { throw new Exception(); }
int n = Integer.parseInt(fullval.substring(0,2));
if (n < 0 || n > 23) { throw new Exception(); }
n = Integer.parseInt(fullval.substring(3,5));
if (n < 0 || n > 59) { throw new Exception(); }
n = Integer.parseInt(fullval.substring(6,8));
if (n < 0 || n > 59) { throw new Exception(); }
n = Integer.parseInt(fullval.substring(9,12));
if (n < 0 || n > 999) { throw new Exception(); }
} catch (Exception e) {
throw new CmdLineException(Strings.get(
"TimeParam.invalidTimeFormat",
new Object[] { val, sTimeFmtDisplay }));
}
}
/**
* Returns a Date object whose date portion is taken from the
* passed Date object, and whose time portion is
* taken from the first value set.
*
* @param datePortion The date portion of the returned date will match
* the date portion of this object. Any time
* portion of this object will be discarded, and
* the time associated with the initial value of
* this parameter substituted.
* @return See the paramter description.
*/
public Date getDate(Date datePortion) {
SimpleDateFormat fmt = new SimpleDateFormat("MM/dd/yy");
String sDate = fmt.format(datePortion);
Date ret;
try {
fmt = new SimpleDateFormat("MM/dd/yy " + sTimeFmt);
ret = fmt.parse(sDate + " " + fullTime(getValue()));
} catch (ParseException e) {
// should never happen!!
throw new RuntimeException(e);
}
return ret;
}
/**
* Returns Date objects whose date portion is taken from the
* passed Date object, and whose time portion is
* taken from the first value set.
*
* @param datePortion The date portion of the returned dates will match
* the date portion of this object. Any time
* portion of this object will be discarded, and
* the time associated with the values of
* this parameter substituted.
* @return See the paramter description.
*/
public Date[] getDates(Date datePortion) {
SimpleDateFormat fmt = new SimpleDateFormat("MM/dd/yy");
String sDate = fmt.format(datePortion);
Collection vals = getValues();
Date[] ret = new Date[vals.size()];
fmt = new SimpleDateFormat("MM/dd/yy " + sTimeFmt);
int i = 0;
for (Iterator itr = vals.iterator(); itr.hasNext(); ) {
try {
ret[i] = fmt.parse(sDate + " " + fullTime((String)itr.next()));
i++;
} catch (ParseException e) {
// should never happen!!
throw new RuntimeException(e);
}
}
return ret;
}
/**
* Gets the number of milliseconds represented by the first value
* of the parameter.
* This is equal to:
*
* hours*MILLIS_PER_HOUR + mins*MILLIS_PER_MINUTE + secs*MILLIS_PER_SECOND + ms
*
*
* @return the number of milliseconds represented by the
* first value of the parameter
*/
public long getMilliValue() {
String val = fullTime(getValue());
long ret;
try {
ret = calculateMillis(val);
} catch (NumberFormatException e) {
// should never happen
throw new RuntimeException(e);
}
return ret;
}
/**
* Gets the number of milliseconds represented by all values.
*
* @return the number of milliseconds represented by all values
* @see #getMilliValue()
*/
public long[] getMilliValues() {
Collection vals = getValues();
long[] ret = new long[vals.size()];
int i = 0;
for (Iterator itr = vals.iterator(); itr.hasNext(); ) {
String val = fullTime((String)itr.next());
try {
ret[i] = calculateMillis(val);
i++;
} catch (NumberFormatException e) {
// should never happen
throw new RuntimeException(e);
}
}
return ret;
}
/**
* Convenience method to calculate the number of milliseconds a String
* time represents.
*
* @param time the String time
* @return the number of milliseconds represented by
* time
* @throws NumberFormatException if time does not parse
* as it should
*/
private long calculateMillis(String val) throws NumberFormatException {
return Long.parseLong(val.substring(0,2)) * MILLIS_PER_HOUR +
Long.parseLong(val.substring(3,5)) * MILLIS_PER_MINUTE +
Long.parseLong(val.substring(6,8)) * MILLIS_PER_SECOND +
Long.parseLong(val.substring(9,12));
}
/**
* Gets the first value with all time components filled in, from the
* defaults, if necessary. This method is guaranteed to return a
* String in the format "HH:mm:ss:SSS", even if the user did not
* specify second or millisecond components (unlike getValue()
* , which returns exactly what the user specified).
*
* @return see description
*/
public String getFullValue() {
return fullTime(getValue());
}
/**
* Gets the values with all time components filled in, from the
* defaults, if necessary. This method is guaranteed to return
* Strings in the format "HH:mm:ss:SSS", even if the user did not
* specify second or millisecond components (unlike getValues()
* , which returns exactly what the user specified).
*
* @return see description
*/
public String[] getFullValues() {
Collection vals = getValues();
String[] ret = new String[vals.size()];
int i = 0;
for (Iterator itr = vals.iterator(); itr.hasNext(); ) {
ret[i] = fullTime((String)itr.next());
}
return ret;
}
/**
* Sets the seconds default to use if not specified by the user.
* This will default to 0 if never specified for a TimeParam object.
*
* @param defaultSeconds the seconds default to use if not specified
* by the user
* @see #getDefaultSeconds()
*/
public void setDefaultSeconds(int defaultSeconds) {
if (defaultSeconds < 0 || defaultSeconds > 59) {
throw new IllegalArgumentException(Strings.get(
"TimeParam.invalidSeconds",
new Object[] { new Integer(defaultSeconds) }));
}
this.defaultSeconds = defaultSeconds;
}
/**
* Gets the seconds default to use if not specified by the user.
* This will default to 0 if never specified for a TimeParam object.
*
* @return the seconds default to use if not specified by
* the user
* @see #setDefaultSeconds(int) setDefaultSeconds()
*/
public int getDefaultSeconds() {
return defaultSeconds;
}
/**
* Sets the default millisecond value to use if not specified by the user.
* This will default to 0 if never specified for a TimeParam object.
*
* @param defaultMilliSeconds the default millisecond value to use if
* not specified by the user
* @see #getDefaultMilliSeconds()
*/
public void setDefaultMilliSeconds(int defaultMilliSeconds) {
if (defaultMilliSeconds < 0 || defaultMilliSeconds > 999) {
throw new IllegalArgumentException(Strings.get(
"TimeParam.invalidMilliSeconds",
new Object[] { new Integer(defaultMilliSeconds) }));
}
this.defaultMilliSeconds = defaultMilliSeconds;
}
/**
* Gets the default millisecond value to use if not specified by the user.
* This will default to 0 if never specified for a TimeParam object.
*
* @return the default millisecond value to use if not
* specified by the user
* @see #setDefaultMilliSeconds(int) setDefaultMilliSeconds()
*/
public int getDefaultMilliSeconds() {
return defaultMilliSeconds;
}
/**
* Sets acceptable values for this Parameter.
*
* @param vals A Collection of Strings representing
* the acceptable times. If the seconds and/or
* milliseconds portion of the time is left off,
* the default values will be used when user input
* is compared.
*/
public void setAcceptableValues(Collection vals) {
if (vals == null || vals.size() == 0) {
acceptableTimes = null;
} else {
acceptableTimes = new String[vals.size()];
int i = 0;
for (Iterator itr = vals.iterator(); itr.hasNext(); ) {
acceptableTimes[i] = itr.next().toString();
i++;
}
}
}
/**
* Sets acceptable values for this Parameter.
*
* @param vals An array of Strings representing
* the acceptable times. If the seconds and/or
* milliseconds portion of the time is left off,
* the default values will be used when user input
* is compared.
*/
public void setAcceptableValues(String[] vals) {
if (vals == null || vals.length == 0) {
acceptableTimes = null;
} else {
acceptableTimes = vals;
}
}
/**
* Gets the values that are acceptable for this parameter, if a restricted
* set exists. If there is no restricted set of acceptable values, null
* is returned.
*
* @return a set of acceptable values for the Parameter, or
* null if there is none.
* @see #setAcceptableValues(String[]) setAcceptableValues()
*/
public String[] getAcceptableValues() {
return acceptableTimes;
}
/**
* Converts a String value to its Date equivalent, filling in default
* seconds and milliseconds as necessary.
*
* @param val the String to be converted
* @return the Date object represented by val
*/
private String fullTime(String val) {
if (val.length() == 5) {
val = val + ":" + secondFmt.format(defaultSeconds);
}
if (val.length() == 8) {
val = val + ":" + msFmt.format(defaultMilliSeconds);
}
return val;
}
}
pdfsam-1.1.4/jcmdline/src/java/jcmdline/PosixCmdLineParser.java 0000644 0001750 0001750 00000026277 10722536254 024411 0 ustar twerner twerner /*
* PosixCmdLineParser.java
*
* Classes:
* public PosixCmdLineParser
*
* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (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.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is the Java jcmdline (command line management) package.
*
* The Initial Developer of the Original Code is Lynne Lawrence.
*
* Portions created by the Initial Developer are Copyright (C) 2002
* the Initial Developer. All Rights Reserved.
*
* Contributor(s): Lynne Lawrence
*
* ***** END LICENSE BLOCK *****
*/
package jcmdline;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
/**
* Used to parse the parameters associated with an executable's
* command line.
*
* The following semantics are used throughout the documentation for this
* class. A command line parameter refers to either a command line
* option, or a command line argument.
*
A command line option is
* preceded by either a '-',
* or a '--', and may, optionally, have an associated value separated from the
* option "tag" by a space or an '='. Command line options end with the
* first parameter (that has not already been parsed as an
* option or option value) that
* does not start with a '-' or a '--', or when a '--' appears by itself
* as a parameter. A '--' must be specified
* alone to signal the end of options when the
* first command line argument starts with a '-'.
*
Command line
* arguments are what are left on the command line after all
* options have been processed.
*
* This class is used as in the following example of a 'cat' facsimile in java:
*
* Command Line Parsing
*
* The {@link #parse(String[], Map, List) parse()}
* method parses option tags in a
* case insensitive manner.
* It will accept truncated option tags as long as the tag remains
* un-ambiguous, execpt for hidden options. The tag for hidden options
* must be fully specified. An option's value may be separated from its'
* tag by a space or an '='. A BooleanParam may be specified either without
* a value (in which case it is set to true), or with an '='
* followed by its value. If a BooleanParam is specified more than once,
* the final specification takes precedence.
*
* The following command lines are all equivalent:
*
* Any problem found while parse() processes the command
* line will cause a {@link CmdLineException} to be thrown.
*
* Information on using CmdLineParsers can be found in the jcmdline
* User Guide.
*
* @author Lynne Lawrence
* @version jcmdline Rel. @VERSION@ $Id: PosixCmdLineParser.java,v 1.2 2002/12/07 14:22:06 lglawrence Exp $
* @see Parameter
*/
public class PosixCmdLineParser implements CmdLineParser {
/**
* a usage formatter suitable for this CmdLineParser's format
* @see #setUsageFormatter(UsageFormatter) setUsageFormatter()
* @see #getUsageFormatter()
*/
private UsageFormatter usageFormatter;
/**
* constructor
*/
public PosixCmdLineParser () {
setUsageFormatter(new TextUsageFormatter());
}
/**
* parse the specified command line arguments
*
* @param params command line arguments passed to the main() method
* of CmdLineParser's creating class.
* @return This method will exit, rather than returning, if one of the
* following conditions is met:
*
*
-help,
* -help!,
* -version,
* -h, or
* -?,
* are amongst the command line arguments - the
* appropriate information is displayed on stdout,
* and the program exits with status 0.
*
a command line argument is incorrectly specified -
* an error message is displayed and the program
* exits with status 1.
*
a required command line argument is missing - an error
* message is displayed and the program exits with status 1.
*
* @throws CmdLineException in case of any parse error.
*/
public void parse(String[] clargs, Map opts, List args)
throws CmdLineException {
if (clargs == null) {
clargs = new String[] {};
}
int i = processOptions(clargs, opts);
processArguments(i, clargs, args);
}
/**
* Sets a usage formatter suitable for this CmdLineParser's format.
*
* @param usageFormatter a usage formatter suitable for this
* CmdLineParser's format
* @see #getUsageFormatter()
*/
public void setUsageFormatter(UsageFormatter usageFormatter) {
this.usageFormatter = usageFormatter;
}
/**
* Gets a usage formatter suitable for this CmdLineParser's format.
*
* @return a usage formatter suitable for this
* CmdLineParser's format
* @see #setUsageFormatter(UsageFormatter) setUsageFormatter()
*/
public UsageFormatter getUsageFormatter() {
return usageFormatter;
}
/**
* Processes the command line options.
*
This method has package visibility in order that it may be called
* by unit tests.
*
* @param params the command line arguments
* @return the number of command line arguments that were
* "used up" in option processing
* @throws CmdLineException if any processing errors are
* encountered.
*/
private int processOptions(String[] params, Map options)
throws CmdLineException {
String tag;
String val;
int equalsIdx;
Parameter p;
int tagIdx;
int i;
for (i = 0; i < params.length; i++) {
val = null;
if (params[i].equals("--")) { // end of options
i++;
break;
} else if (params[i].startsWith("-")) { // have an option
tagIdx = 1;
if (params[i].startsWith("--")) {
tagIdx = 2;
}
if (params[i].length() == tagIdx) {
throw new CmdLineException(
Strings.get("PosixCmdLineParser.optionNoTag"));
}
tag = params[i].substring(tagIdx);
// See if we have an option specified as =
if ((equalsIdx = tag.indexOf("=")) != -1) {
val = tag.substring(equalsIdx + 1);
tag = tag.substring(0, equalsIdx);
}
p = findMatchingOption(tag, options);
if (p instanceof OptionTakesNoValue) {
if (val == null) {
val = ((OptionTakesNoValue) p).getDefaultValue();
}
} else if (val == null) {
if (i == params.length - 1) {
throw new CmdLineException(
Strings.get("PosixCmdLineParser.missingOptionValue",
new Object[] { tag }));
}
val = params[++i];
}
p.addValue(val);
} else {
break; // end of options
}
}
return i;
}
/**
* processes the command line arguments (what is left on the command line
* after all options and their values have been processed)
*
* @param stIdx the index into params where processing
* is to start
* @param params the command line parameters
* @throws CmdLineException if any processing errors are
* encountered.
*/
private void processArguments(int stIdx, String[] params, List args)
throws CmdLineException {
int argIdx = 0;
Parameter p;
for (int pIdx = stIdx; pIdx < params.length; pIdx++) {
if (argIdx >= args.size()) {
throw new CmdLineException(
Strings.get("PosixCmdLineParser.extraArg",
new Object[] { params[pIdx] }));
}
p = (Parameter) args.get(argIdx);
p.addValue(params[pIdx]);
if (! p.isMultiValued()) {
argIdx++;
}
}
}
/**
* Find an option that matches the specified tag. The tag may be an
* abbreviation for the option. Abbreviations will work as long as they
* are unique enough to match one, and only one, option. Comparison is
* done in a case-insensitive manner.
*
* @param tag the option tag to be matched
* @return The associated Parameter object. If a matching
* Parameter
* is not found, this method will issue the appropriate
* error message and the program will exit with
* exit status 1.
* @throws CmdLineException if an option tag is ambiguous or not defined.
*/
private Parameter findMatchingOption(String tag, Map options)
throws CmdLineException {
String lctag = tag.toLowerCase();
String fulltag = null;
String tmptag;
if (options.containsKey(lctag)) {
return (Parameter) options.get(lctag);
}
for (Iterator itr = options.keySet().iterator(); itr.hasNext(); ) {
tmptag = (String)itr.next();
if (((Parameter) options.get(tmptag)).isHidden()) {
// hidden options must be fully specified
continue;
}
if (tmptag.startsWith(lctag)) {
if (fulltag != null) {
throw new CmdLineException(
Strings.get("PosixCmdLineParser.ambiguousOption",
new Object[] { "-" + tag }));
}
fulltag = tmptag;
}
}
if (fulltag == null) {
throw new CmdLineException(
Strings.get("PosixCmdLineParser.invalidOption",
new Object[] { tag }));
}
return (Parameter)options.get(fulltag);
}
}
pdfsam-1.1.4/jcmdline/src/java/jcmdline/AbstractParameter.java 0000644 0001750 0001750 00000043522 10711667504 024273 0 ustar twerner twerner /*
* AbstractParameter.java
*
* Classes:
* public AbstractParameter
*
* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (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.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is the Java jcmdline (command line management) package.
*
* The Initial Developer of the Original Code is Lynne Lawrence.
*
* Portions created by the Initial Developer are Copyright (C) 2002
* the Initial Developer. All Rights Reserved.
*
* Contributor(s): Lynne Lawrence
*
* ***** END LICENSE BLOCK *****
*/
package jcmdline;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
/**
* Base class for command line parameters.
*
* To implement a concrete Parameter class by subclassing this class,
* the following should be done:
*
*
Override the {@link #validateValue(String) validateValue()} method.
* This method is called any time an attempt is made to add or set
* values.
*
Implement constructors applicable for the new type of Parameter.
*
Call {@link #setOptionLabel(String) setOptionLabel()} from the
* constructors to set a
* reasonable option label for the new type of parameter.
*
Provide type-specific access methods for retrieval of the Parameter
* value. For instance, {@link FileParam} provides the
* getFiles() method to retrieve its values as File
* objects.
*
*
* A simple Parameter class that accepts only strings of a specified length
* might look as follows:
*
* public class FixedLenParam extends AbstractParameter {
*
* private int length;
*
* public FixedLenParam(String tag, String desc, int length) {
* setTag(tag);
* setDesc(desc);
* this.length = length;
* setOptionLabel("<s>");
* }
*
* public void validateValue(String val) throws CmdLineException {
* super.validateValue(val); // check acceptable values, etc..
* if (val.length() != length) {
* throw new CmdLineException(getTag() + " must be a string of " +
* length + " characters in length");
* }
*
* }
* }
*
*
* @author Lynne Lawrence
* @version jcmdline Rel. @VERSION@ $Id: AbstractParameter.java,v 1.2 2002/12/07 14:22:06 lglawrence Exp $
*/
public abstract class AbstractParameter implements Parameter {
/**
* the tag which uniquely identifies the parameter, and will be used to
* identify the parameter on the command line if the parameter is used
* as an option
*/
protected String tag;
/**
* Indicates whether or not the parameter is optional. The default is
* true, indicating that the parameter is optional.
*/
protected boolean optional = true;
/**
* Indicates whether the parameter can have multiple values.
* The default is
* false, indicating that the parameter can only accept a single value.
*/
protected boolean multiValued = false;
/**
* a description of the parameter to be displayed in the usage */
protected String desc;
/**
* indicates that the parameter is hidden and will not be displayed in the
* normal usage - default is false
*/
protected boolean hidden = false;
/**
* indicates that the value of the parameter has been set
*/
protected boolean set;
/**
* the value(s) of the entity
*/
protected ArrayList values = new ArrayList();
/**
* The label that should be used for a Parameter option's value in the
* usage
* @see #setOptionLabel(String) setOptionLabel()
* @see #getOptionLabel()
*/
protected String optionLabel = null;
/**
* a set of restricted values the Parameter may take
* @see #setAcceptableValues(String[]) setAcceptableValues()
* @see #getAcceptableValues()
*/
protected String[] acceptableValues;
/**
* During parse, ignore missing required Parameters if this Parameter is
* set. Typically used by Parameters that cause an action then call
* System.exit(), like "-help".
* @see #setIgnoreRequired(boolean) setIgnoreRequired()
* @see #getIgnoreRequired()
*/
protected boolean ignoreRequired;
/**
* gets an indicator that the parameter's value has been set
*
* @return true if the parameter's value has been set, false
* otherwise
*/
public boolean isSet() {
return set;
}
/**
* sets the value of the hidden indicator
*
* @param hidden true ({@link #HIDDEN}) if the parameter is a
* hidden parameter
*/
public void setHidden(boolean hidden) {
this.hidden = hidden;
}
/**
* gets the value of the hidden indicator
*
* @return true ({@link #HIDDEN}) if the parameter is a
* hidden parameter
*/
public boolean isHidden() {
return hidden;
}
/**
* sets the value of this parameter's description
*
* @param desc a description of the parameter, suitable for display in
* the command's usage
* @throws IllegalArgumentException if desc is
* fewer than 5 charaters.
*/
public void setDesc(String desc) throws IllegalArgumentException {
int minDescLen = 5;
if (desc.length() < minDescLen) {
throw new IllegalArgumentException(Strings.get(
"AbstractParameter.descTooShort", new Object[] { tag }));
}
this.desc = desc;
}
/**
* gets the value of the parameter's description
*
* @return this parameter's description
*/
public String getDesc() {
return desc;
}
/**
* sets the value of tag
*
* @param tag a unique identifier for this parameter. If the
* parameter is used as an option, it will be used to
* identify the option on the command line. In the case
* where the parameter is used as an argument, it will
* only be used to identify the argument in the usage
* statement. Tags must be made up of any character but
* '='.
* @throws IllegalArgumentException if the length of tag
* is less than 1, or tag contains an
* invalid character.
*/
public void setTag(String tag) throws IllegalArgumentException {
if (tag == null || tag.length() < 1) {
throw new IllegalArgumentException(Strings.get(
"AbstractParameter.emptyTag"));
}
if (tag.indexOf("=") != -1) {
throw new IllegalArgumentException(Strings.get(
"AbstractParameter.illegalCharInTag",
new Object[] { tag, "=" }));
}
this.tag = tag;
}
/**
* gets the value of tag
*
* @return a unique identifier for this parameter
* @see #setTag(String) setTag()
*/
public String getTag() {
return tag;
}
/**
* sets the value of the multiValued indicator
*
* @param multiValued true if the parameter can have multiple values
*/
public void setMultiValued(boolean multiValued) {
this.multiValued = multiValued;
}
/**
* gets the value of multiValued indicator
*
* @return true if the parameter can have multiple values
*/
public boolean isMultiValued() {
return multiValued;
}
/**
* indicates whether or not the parameter is optional
*
* @param optional true if the parameter is optional
*/
public void setOptional(boolean optional) {
this.optional = optional;
}
/**
* returns the value of the optional indicator
*
* @return true if the parameter is optional
*/
public boolean isOptional() {
return optional;
}
/**
* Gets the values that are acceptable for this parameter, if a restricted
* set exists. If there is no restricted set of acceptable values, null
* is returned.
*
* @return a set of acceptable values for the Parameter, or
* null if there is none.
* @see #setAcceptableValues(String[]) setAcceptableValues()
*/
public String[] getAcceptableValues() {
return acceptableValues;
}
/**
* Sets the values that are acceptable for this parameter, if a restricted
* set exists. A null vals value, or an empty vals
* array, will result in any previously set acceptable values being cleared.
*
* @param vals the new acceptable values
* @see #getAcceptableValues()
*/
public void setAcceptableValues(String[] vals) {
if (vals == null || vals.length == 0) {
acceptableValues = null;
} else {
acceptableValues = vals;
}
}
/**
* Sets the values that are acceptable for this parameter, if a restricted
* set exists. A null vals value, or an empty vals
* Collection, will result in any previously set acceptable values being
* cleared.
*
* The toString() values of the Objects in vals
* will be used for the acceptable values.
*
* @param vals the new acceptable values
*/
public void setAcceptableValues(Collection vals) {
if (vals == null || vals.size() == 0) {
acceptableValues = null;
} else {
acceptableValues = new String[vals.size()];
int i = 0;
for (Iterator itr = vals.iterator(); itr.hasNext(); ) {
acceptableValues[i] = itr.next().toString();
i++;
}
}
}
/**
* Adds the specified string as a value for this entity after calling
* validateValue() to validate.
*
* @param value the value to be added
* @throws CmdLineException if the value of the entity
* has already been set and multiValued is
* not true, or if
* {@link #validateValue(String) validateValue()}
* detects a problem.
*/
public void addValue(String value) throws CmdLineException {
if (values.size() >= 1 && !multiValued) {
throw new CmdLineException(Strings.get(
"AbstractParameter.specifiedMoreThanOnce",
new Object[] { tag }));
}
validateValue(value);
values.add(value);
set = true;
}
/**
* Sets the value of the parameter to the specified string after calling
* validateValue() to validate.
*
* @param value the new value of the parameter
* @throws if {@link #validateValue(String) validateValue()}
* detects a problem.
*/
public void setValue(String value) throws CmdLineException {
values.clear();
addValue(value); // Let addValue() validate
}
/**
* Sets the values of the parameter to those specified after calling
* validateValue() to validate.
*
* @param values A collection of String objects to be used as the
* parameter's values.
* @throws ClassCastException if the Collection contains object that
* are not Strings.
* @throws CmdLineException if more than one value is specified
* and multiValued is not true, or
* if {@link #validateValue(String) validateValue()}
* detects a problem.
*/
public void setValues(Collection values) throws CmdLineException {
this.values.clear();
for (Iterator itr = values.iterator(); itr.hasNext(); ) {
addValue((String) itr.next()); // let addValue() validate
}
}
/**
* Sets the values of the parameter to those specified after calling
* validateValue() to validate.
*
* @param values The String objects to be used as the
* parameter's values.
* @throws CmdLineException if more than one value is specified
* and multiValued is not true, or
* if {@link #validateValue(String) validateValue()}
* detects a problem.
*/
public void setValues(String[] values) throws CmdLineException {
this.values.clear();
for (int i = 0; i < values.length; i++) {
addValue(values[i]); // let addValue() validate
}
}
/**
* Verifies that value is valid for this entity.
*
* The implementation in AbstractParameter is to verify that, if there
* are specific acceptableValues associated with the Parameter, the
* value is one of those specified. Any additional validation must
* be done by a subclass. Because the validation performed by this
* method is applicable to most, if not all Parameters, it is recommended
* that subclasses call it from within their override methods:
*
* public void validateValue(String value) throws CmdLineException {
* super.validateValue(value);
* // do some subclass-specific validation
* .
* .
* }
*
*
* @param value the value to be validated
* @throws CmdLineException if value is not valid.
*/
public void validateValue(String value) throws CmdLineException {
if (acceptableValues != null) {
for (int i = 0; i < acceptableValues.length; i++) {
if (value.equals(acceptableValues[i])) {
return;
}
}
int maxExpectedAVLen = 200;
StringBuffer b = new StringBuffer(maxExpectedAVLen);
for (int i = 0; i < acceptableValues.length; i++) {
b.append("\n " + acceptableValues[i]);
}
throw new CmdLineException(Strings.get(
"Parameter.valNotAcceptableVal",
new Object[] { value, tag, b.toString() }));
}
}
/**
* The value of the parameter, in the case where the parameter is not
* multi-valued. For a multi-valued parameter, the first value specified
* is returned.
*
* @return The value of the parameter as a String, or null if
* the paramter has not been set.
* @see #getValues()
*/
public String getValue() {
if (values.size() == 0) {
return null;
}
return (String) values.get(0);
}
/**
* gets the values associated with this Parameter
*
* @return The values associated with this Parameter. Note
* that this might be an empty Collection if the
* Parameter has not been set.
* @see #isSet()
*/
public Collection getValues() {
return values;
}
/**
* Sets the value of optionLabel.
* This label will be used when the usage for the command is displayed.
* For instance, a date parameter might use "<mm/dd/yy>". This could
* then be displayed as in the following usage.
*
* st_date <mm/dd/yy> the start date of the report
*
* The default is the empty string.
* @param optionLabel The string used as a label for the parameter's
* value. If null, an empty string is used.
* @see #getOptionLabel()
*/
public void setOptionLabel(String optionLabel) {
this.optionLabel = optionLabel;
}
/**
* gets the value of optionLabel
*
* @return the string used as a label for the parameter's
* value
* @see #setOptionLabel(String) setOptionLabel()
*/
public String getOptionLabel() {
return ((optionLabel == null) ? "" : optionLabel);
}
/**
* Sets a flag such that during parse, missing required Parameters are
* ignored
* if this Parameter is set. Typically used by Parameters that cause an
* action then call System.exit(), like "-help".
*
* @param ignoreRequired set to true to ignore missing
* required Parameters if this Parameter is set
* @see #getIgnoreRequired()
*/
public void setIgnoreRequired(boolean ignoreRequired) {
this.ignoreRequired = ignoreRequired;
}
/**
* Gets the flag indicating that during parse, missing required
* Parameters are ignored
* if this Parameter is set. Typically used by Parameters that cause an
* action then call System.exit(), like "-help".
*
* @return true if missing required Parameters
* will be ignored when this Parameter is set.
* @see #setIgnoreRequired(boolean) setIgnoreRequired()
*/
public boolean getIgnoreRequired() {
return ignoreRequired;
}
}
pdfsam-1.1.4/jcmdline/src/java/jcmdline/strings.properties 0000644 0001750 0001750 00000032261 10725305740 023625 0 ustar twerner twerner #==============================================================================
# errors.properties
#
#------------------------------------------------------------------------------
# error messages for the util.jcmdline class.
#
# Author Lynne Lawrence
# Version $Id: strings.properties,v 1.1.1.1 2002/12/06 18:47:01 lglawrence Exp $
#
# ***** BEGIN LICENSE BLOCK *****
# Version: MPL 1.1
#
# The contents of this file are subject to the Mozilla Public License Version
# 1.1 (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.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS IS" basis,
# WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
# for the specific language governing rights and limitations under the
# License.
#
# The Original Code is the Java jcmdline (command line management) package.
#
# The Initial Developer of the Original Code is Lynne Lawrence.
#
# Portions created by the Initial Developer are Copyright (C) 2002
# the Initial Developer. All Rights Reserved.
#
# Contributor(s): Lynne Lawrence
#
# ***** END LICENSE BLOCK *****
#==============================================================================
#------------------------------------------------------------------------------
# AbstractParameter messages
#------------------------------------------------------------------------------
AbstractParameter.descTooShort: \
Description for {0} must be at least 5 characters.
AbstractParameter.emptyTag: A tag may not be an empty string.
AbstractParameter.illegalCharInTag: \
Parameter tag <{0}> contains illegal character <{1}>.\n\
Valid characters are letters, numbers, '_', and '-'.
AbstractParameter.specifiedMoreThanOnce: \
<{0}> may only be specified once.
Parameter.valNotAcceptableVal: \
Invalid value "{0}" specified for <{1}>, expecting one of: {2}
#------------------------------------------------------------------------------
# BasicCmdLineHandler messages
#------------------------------------------------------------------------------
BasicCmdLineHandler.cmdDescTooShort: Command description must be specified.
BasicCmdLineHandler.cmdNameTooShort: Command name must be specified.
BasicCmdLineHandler.duplicateOption: An option ({0}) is defined more than once.
BasicCmdLineHandler.missingRequiredArg: \
Required argument <{0}> has not been specified.
BasicCmdLineHandler.missingRequiredOpt: \
Required option <{0}> has not been specified.
BasicCmdLineHandler.multiValueArgNotLast: \
Multi-valued argument <{0}> must be the last specified because it will \
absorb all command line parameters.
BasicCmdLineHandler.nullArgNotAllowed: Argument parameter may not be null.
BasicCmdLineHandler.requiredArgAfterOptArg: \
Required argument ({0}) may not be specified after optional argument ({1}).
#------------------------------------------------------------------------------
# BooleanParam messages
#------------------------------------------------------------------------------
BooleanParam.false: false
BooleanParam.setValueProgError: \
Programming error: can't set BooleanParam value to "false".
BooleanParam.true: true
#------------------------------------------------------------------------------
# DateParam messages
#------------------------------------------------------------------------------
DateParam.dateFormat: MM/dd/yy
DateParam.invalidDate: \
Invalid date specified for <{0}>, expecting {1}
DateParam.invalidHours: \
Invalid hours value specified ({0}) must be between 0 and 23, inclusive.
DateParam.invalidMinutes: \
Invalid minutes value specified ({0}) must be between 0 and 59, inclusive.
DateParam.invalidSeconds: \
Invalid seconds value specified ({0}) must be between 0 and 59, inclusive.
DateParam.invalidMilliSeconds: \
Invalid milliseconds value specified ({0}) must be between 0 and 999, \
inclusive.
#------------------------------------------------------------------------------
# DateTimeParam messages
#------------------------------------------------------------------------------
DateTimeParam.dateFormat: MM/dd/yy
DateTimeParam.invalidDate: \
Invalid date specified for <{0}>, expecting {1}
#------------------------------------------------------------------------------
# DefaultCmdLineHandler messages
#------------------------------------------------------------------------------
DefaultCmdLineHandler.logOptTag: log
DefaultCmdLineHandler.logOptDesc: sets the log level
DefaultCmdLineHandler.helpOptTag: help
DefaultCmdLineHandler.helpOptDesc: prints help information to stdout; exits
DefaultCmdLineHandler.versionOptTag: version
DefaultCmdLineHandler.versionOptDesc: prints program version to stdout; exits
DefaultCmdLineHandler.usageOptTag1: h
DefaultCmdLineHandler.usageOptTag2: ?
DefaultCmdLineHandler.usageOptDesc: prints usage to stdout; exits
DefaultCmdLineHandler.hiddenUsageOptTag: h!
DefaultCmdLineHandler.hiddenUsageOptDesc: \
prints usage (including hidden options) to stdout; exits
DefaultCmdLineHandler.params: , params:
DefaultCmdLineHandler.classDescTooShort: \
Invalid class description passed to DefaultCmdLineHandler constructor, \n\
must be at least 1 character long.
DefaultCmdLineHandler.classNameTooShort: \
Invalid class name passed to DefaultCmdLineHandler constructor, must be at \
\nleast 1 character long.
DefaultCmdLineHandler.helpMissingArg: \
Help text contains no reference to the <{0}> argument. Help text:\n\
{1}
DefaultCmdLineHandler.helpMissingOption: \
Help text contains no reference to the <{0}> option. Help text:\n\
{1}
DefaultCmdLineHandler.helpTooShort: \
Invalid help text passed to DefaultCmdLineHandler constructor, must be at \n\
least 1 character long.
DefaultCmdLineHandler.optionError: {0}
DefaultCmdLineHandler.versionTooShort: \
Invalid version passed to DefaultCmdLineHandler constructor, must be at \n\
least 1 character long.
#------------------------------------------------------------------------------
# FileParam messages
#------------------------------------------------------------------------------
FileParam.a: a
FileParam.an_existing: an existing
FileParam.defaultDirOptionLabel:
FileParam.defaultFileOptionLabel:
FileParam.directory: directory
FileParam.file: file
FileParam.file_dir: file or directory
FileParam.illegalValue: \
Invalid name ({3}) specified for <{4}>, must be {0}{2} {1}.
FileParam.invalidAttributes: \
Invalid attributes specified: <{0}>, please use static final literals.
FileParam.readable: , readable,
FileParam.readable_writeable: , readable, writeable,
FileParam.valueNotSet: There is no value set for <{0}>.
FileParam.writeable: , writeable,
#------------------------------------------------------------------------------
# HelpCmdLineHandler messages
#------------------------------------------------------------------------------
HelpCmdLineHandler.help.tag: help
HelpCmdLineHandler.help.desc: displays verbose help information
HelpCmdLineHandler.license.tag: license
HelpCmdLineHandler.license.desc: displays license information
HelpCmdLineHandler.license.nolicense: no license informations
HelpCmdLineHandler.helpEmptyError: \
a non-empty help text must be specified to the HelpCmdLineHandler constructor
HelpCmdLineHandler.helpHidden.tag: help!
HelpCmdLineHandler.helpHidden.desc: \
displays verbose help information, including hidden parameters
#------------------------------------------------------------------------------
# IntParam messages
#------------------------------------------------------------------------------
IntParam.defaultOptionLabel:
IntParam.maxLessThanMin: \
Minimum acceptable value ({0}) must not be greater than the maximum ({1})
IntParam.validValues: \
The value for <{0}> must be a number between {1} and {2}, inclusive.
IntParam.valueNotSet: \
There is no value set for <{0}>.
#------------------------------------------------------------------------------
# LongParam messages
#------------------------------------------------------------------------------
LongParam.defaultOptionLabel:
LongParam.maxLessThanMin: \
Minimum acceptable value ({0}) must not be greater than the maximum ({1})
LongParam.validValues: \
The value for <{0}> must be a number between {1} and {2}, inclusive.
LongParam.valueNotSet: \
There is no value set for <{0}>.
#------------------------------------------------------------------------------
# LoggerCmdLineHandler messages
#------------------------------------------------------------------------------
LoggerCmdLineHandler.logFormatterNullError: \
The Formatter passed to setlogFormatter() must not be null
LoggerCmdLineHandler.logOpt.tag: log
LoggerCmdLineHandler.logOpt.desc: \
set the default logging level \
(one of {0}, {1}, {2}, {3}, {4}, {5}, {6}, {7}, or {8})
LoggerCmdLineHandler.streamNullError: \
The stream specified to the LoggerCmdLineHandler may not be null.
#------------------------------------------------------------------------------
# PosixCmdLineParser messages
#------------------------------------------------------------------------------
PosixCmdLineParser.ambiguousOption: Option <{0}> is ambiguous.
PosixCmdLineParser.extraArg: Extra argument specified: <{0}>
PosixCmdLineParser.invalidOption: Option <{0}> is not a valid option.
PosixCmdLineParser.missingOptionValue: Option <{0}> requires a value.
PosixCmdLineParser.optionNoTag: Option "-" is invalid.
#------------------------------------------------------------------------------
# StringFormatHelper messages
#------------------------------------------------------------------------------
StringFormatHelper.labelDescriptionError: \
The number of labels ({0}) passed to formatLabelledList does not match \
the number of descriptions ({1})
StringFormatHelper.lineLenLessThanIndent: \
maximum line length must be greater than indent
StringFormatHelper.lineLenZero: maximum line length must be greater than 0
#------------------------------------------------------------------------------
# StringParam messages
#------------------------------------------------------------------------------
StringParam.defaultOptionLabel:
StringParam.maxTooSmall: Maximum length for {0} must not be less than 0.
StringParam.minTooSmall: Minimum length for {0} must not be less than 0.
StringParam.maxLessThanMin: \
Maximum length for {0} must not be less than the minimum length.
StringParam.valTooLong: \
Parameter for {0} is longer than the maximum allowed length ({1}).
StringParam.valTooShort: \
Parameter for {0} is shorter than the minimum allowed length ({1}).
#------------------------------------------------------------------------------
# Strings messages
#------------------------------------------------------------------------------
Strings.missingKey: Missing string property for key:
#------------------------------------------------------------------------------
# TextUsageFormatter messages
#------------------------------------------------------------------------------
TextUsageFormatter.errorPrefix: ERROR:
TextUsageFormatter.hidden: hidden
TextUsageFormatter.optional: optional
TextUsageFormatter.optIntroNoArgs: where options are:
TextUsageFormatter.optIntroWArgs: and options are:
TextUsageFormatter.required: required
TextUsageFormatter.stdOptionHelp: \
Option tags are not case sensitive, and \
may be truncated as long as they remain unambiguous. Option \
tags must be separated from their corresponding values by \
whitespace, or by an equal sign. Boolean options (options that \
require no associated value) may be specified alone (=true), or as \
'tag=value' where value is 'true' or 'false'.
TextUsageFormatter.usage: Usage:
TextUsageFormatter.usageWOReqOpt: [options]
TextUsageFormatter.usageWReqOpt: options
TextUsageFormatter.where: where:
#------------------------------------------------------------------------------
# TimeParam messages
#------------------------------------------------------------------------------
TimeParam.invalidTimeFormat: Invalid time format ({0}), expecting "{1}"
TimeParam.invalidSeconds: \
Invalid seconds value specified ({0}) must be between 0 and 59, inclusive.
TimeParam.invalidMilliSeconds: \
Invalid milliseconds value specified ({0}) must be between 0 and 999, \
inclusive.
#------------------------------------------------------------------------------
# VersionCmdLineHandler messages
#------------------------------------------------------------------------------
VersionCmdLineHandler.version.desc: displays command's version
VersionCmdLineHandler.version.tag: version
VersionCmdLineHandler.versionEmptyError: \
A version of non-zero length must be specified.
PdfFileParam.a: a
PdfFileParam.an_existing: an existing
PdfFileParam.defaultDirOptionLabel:
PdfFileParam.defaultFileOptionLabel:
PdfFileParam.file: file
PdfFileParam.file_dir: file or directory
PdfFileParam.illegalValue: \
Invalid name ({3}) specified for <{4}>, must be {0}{2} {1}.
PdfFileParam.invalidAttributes: \
Invalid attributes specified: <{0}>, please use static final literals.
PdfFileParam.readable: , readable,
PdfFileParam.readable_writeable: , readable, writeable,
PdfFileParam.valueNotSet: There is no value set for <{0}>.
PdfFileParam.writeable: , writeable,
pdfsam-1.1.4/jcmdline/src/java/jcmdline/CmdLineParser.java 0000644 0001750 0001750 00000006157 10201471366 023353 0 ustar twerner twerner /*
* CmdLineParser.java
*
* jcmdline Rel. @VERSION@ $Id: CmdLineParser.java,v 1.2 2002/12/07 14:22:06 lglawrence Exp $
*
* Classes:
* public CmdLineParser
*
* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (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.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is the Java jcmdline (command line management) package.
*
* The Initial Developer of the Original Code is Lynne Lawrence.
*
* Portions created by the Initial Developer are Copyright (C) 2002
* the Initial Developer. All Rights Reserved.
*
* Contributor(s): Lynne Lawrence
*
* ***** END LICENSE BLOCK *****
*/
package jcmdline;
import java.util.List;
import java.util.Map;
/**
* Interface desribing the API used between the CmdLineHandler and its
* command line parser.
*
* Implementations of this interface are intended to be passed to the
* constructor of a CmdLineHandler, which will then use the implementation
* to parse the command line to its composite elements.
*
* Information on using CmdLineParsers can be found in the jcmdline
* User Guide.
*
* @author Lynne Lawrence
* @version jcmdline Rel. @VERSION@ $Id: CmdLineParser.java,v 1.2 2002/12/07 14:22:06 lglawrence Exp $
*/
public interface CmdLineParser {
/**
* Parses the passed command line arguments into sets of options and
* arguments. Following a call to this method, the appropriate values
* of the parameters and options will be set.
*
* @param clargs the command line arguments
* @param opts the expected command line options
* @param args the expected command line arguments (what is left
* on the command line after the options have been
* processed.
* @throws CmdLineException if the clargs fail to parse
* properly into the expected options and arguments.
*/
public void parse(String clargs[], Map opts, List args)
throws CmdLineException;
/**
* Sets a usage formatter suitable for this CmdLineParser's format.
*
* @param usageFormatter a usage formatter suitable for this
* CmdLineParser's format
* @see #getUsageFormatter()
*/
public void setUsageFormatter(UsageFormatter usageFormatter) ;
/**
* Gets a usage formatter suitable for this CmdLineParser's format.
*
* @return a usage formatter suitable for this
* CmdLineParser's format
* @see #setUsageFormatter(UsageFormatter) setUsageFormatter()
*/
public UsageFormatter getUsageFormatter() ;
}
pdfsam-1.1.4/jcmdline/src/java/jcmdline/DateTimeParam.java 0000644 0001750 0001750 00000056163 10722536124 023344 0 ustar twerner twerner /*
* DateTimeParam.java
*
* jcmdline Rel. @VERSION@ $Id: DateTimeParam.java,v 1.2 2002/12/07 14:22:06 lglawrence Exp $
*
* Classes:
* public DateTimeParam
*
* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (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.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is the Java jcmdline (command line management) package.
*
* The Initial Developer of the Original Code is Lynne Lawrence.
*
* Portions created by the Initial Developer are Copyright (C) 2002
* the Initial Developer. All Rights Reserved.
*
* Contributor(s): Lynne Lawrence
*
* ***** END LICENSE BLOCK *****
*/
package jcmdline;
import java.text.DecimalFormat;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Collection;
import java.util.Date;
import java.util.Iterator;
/**
* A parameter that accepts a date and time as its value.
*
* The format for the date is taken from the strings
* ResourceBundle. The format for the time is "HH:mm:ss:SSS", where
* the seconds and/or milliseconds portion may be left off by the user,
* in which case they will be defaulted.
*
* Sample Usage:
*
* DateTimeParam startTimeParam =
* new DateTimeParam("startTime",
* "start time of report",
* DateTimeParam.REQUIRED);
* DateTimeParam endTimeParam =
* new DateTimeParam("endTime",
* "end time of report",
* DateTimeParam.REQUIRED);
*
* // Seconds and millis for startTime will both be 0 by default.
* // Set the seconds and millis for the end of the report to be the end
* // of a minute.
* endTimeParam.setDefaultSeconds(59);
* endTimeParam.setDefaultMilliSeconds(999);
*
* CmdLineHandler cl = new DefaultCmdLineHandler(
* "myreport", "generate activity report",
* new Parameter[] {},
* new Parameter[] { startTimeParam, endTimeParam });
*
* cl.parse();
*
* // Don't need to check isSet() because params are REQUIRED
* Date stTime = startTimeParam.getDate();
* Date enTime = endTimeParam.getDate();
* .
* .
*
* This will result in a command line that may be executed as:
*
*
* @author Lynne Lawrence
* @version jcmdline Rel. @VERSION@ $Id: DateTimeParam.java,v 1.2 2002/12/07 14:22:06 lglawrence Exp $
* @see DateParam
* @see TimeParam
*/
public class DateTimeParam extends AbstractParameter {
private static final String sDateFmt =
Strings.get("DateTimeParam.dateFormat");
private static final String sTimeFmt = "HH:mm:ss:SSS";
private static final String sTimeFmtDisplay = "HH:mm[:ss[:SSS]]";
private static final SimpleDateFormat dateFmt =
new SimpleDateFormat(sDateFmt + " " + sTimeFmt);
private static final DecimalFormat secondFmt = new DecimalFormat("00");
private static final DecimalFormat msFmt = new DecimalFormat("000");
private Date date = null;
/**
* The seconds default to use if not specified by the user.
* This will default to 0 if never specified for a DateTimeParam object.
* @see #setDefaultSeconds(int) setDefaultSeconds()
* @see #getDefaultSeconds()
*/
private int defaultSeconds = 0;
/**
* The default millisecond value to use if not specified by the user.
* This will default to 0 if never specified for a DateTimeParam object.
* @see #setDefaultMilliSeconds(int) setDefaultMilliSeconds()
* @see #getDefaultMilliSeconds()
*/
private int defaultMilliSeconds = 0;
/**
* constructor - creates single-valued, optional, public
* parameter
*
* @param tag a unique identifier for this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @throws IllegalArgumentException if tag
* or are invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
*/
public DateTimeParam(String tag, String desc) {
this(tag, desc, OPTIONAL, SINGLE_VALUED, PUBLIC);
}
/**
* constructor - creates single-valued, public parameter which will
* will be either optional or required, as specified.
*
* @param tag a unique identifier for this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param optional {@link Parameter#OPTIONAL OPTIONAL} if
* optional,
* {@link Parameter#REQUIRED REQUIRED} if required
* @throws IllegalArgumentException if any of the specified
* parameters are invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
*/
public DateTimeParam(String tag, String desc, boolean optional) {
this(tag, desc, optional, SINGLE_VALUED, PUBLIC);
}
/**
* constructor - creates a public parameter which will
* will be either optional or required, and/or multi-valued, as specified.
*
* @param tag a unique identifier for this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param optional {@link Parameter#OPTIONAL OPTIONAL} if
* optional,
* {@link Parameter#REQUIRED REQUIRED} if required
* @param multiValued {@link Parameter#MULTI_VALUED MULTI_VALUED} if
* the parameter can accept multiple values,
* {@link Parameter#SINGLE_VALUED SINGLE_VALUED}
* if the parameter can contain only a single value
* @throws IllegalArgumentException if any of the specified
* parameters are invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see Parameter#SINGLE_VALUED SINGLE_VALUED
* @see Parameter#MULTI_VALUED MULTI_VALUED
*/
public DateTimeParam(String tag,
String desc,
boolean optional,
boolean multiValued) {
this(tag, desc, optional, multiValued, PUBLIC);
}
/**
* constructor - creates a parameter which will
* will be either optional or required, single or multi-valued, and
* hidden or public as specified.
*
* @param tag a unique identifier for this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param optional {@link Parameter#OPTIONAL OPTIONAL} if
* optional,
* {@link Parameter#REQUIRED REQUIRED} if required
* @param multiValued {@link Parameter#MULTI_VALUED MULTI_VALUED} if
* the parameter can accept multiple values,
* {@link Parameter#SINGLE_VALUED SINGLE_VALUED}
* if the parameter can contain only a single value
* @param hidden {@link Parameter#HIDDEN HIDDEN} if parameter is
* not to be listed in the usage,
* {@link Parameter#PUBLIC PUBLIC} otherwise.
* @throws IllegalArgumentException if any of the specified
* parameters are invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see Parameter#SINGLE_VALUED SINGLE_VALUED
* @see Parameter#MULTI_VALUED MULTI_VALUED
* @see Parameter#HIDDEN HIDDEN
* @see Parameter#PUBLIC PUBLIC
*/
public DateTimeParam(String tag,
String desc,
boolean optional,
boolean multiValued,
boolean hidden) {
this.setTag(tag);
this.setDesc(desc);
this.setOptional(optional);
this.setMultiValued(multiValued);
this.setHidden(hidden);
this.setOptionLabel(sDateFmt + " " + sTimeFmtDisplay);
}
/**
* constructor - creates a single-valued, optional, public,
* number parameter whose value must be one of the specified values.
*
* @param tag the tag associated with this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param acceptableValues the acceptable values for the parameter
* @throws IllegalArgumentException if any parameter is
* invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see #setAcceptableDates(Date[]) setAcceptableDates()
*/
public DateTimeParam(String tag, String desc, Date[] acceptableValues) {
this(tag, desc, acceptableValues, OPTIONAL, SINGLE_VALUED, PUBLIC);
}
/**
* constructor - creates a single-valued, public,
* number parameter whose value must be one of the specified values,
* and which is required or optional, as specified.
*
* @param tag the tag associated with this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param acceptableValues the acceptable values for the parameter
* @param optional {@link Parameter#OPTIONAL OPTIONAL} if
* optional,
* {@link Parameter#REQUIRED REQUIRED} if required
* @throws IllegalArgumentException if any parameter is
* invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see #setAcceptableDates(Date[]) setAcceptableDates()
* @see Parameter#OPTIONAL OPTIONAL
* @see Parameter#REQUIRED REQUIRED
*/
public DateTimeParam(String tag,
String desc,
Date[] acceptableValues,
boolean optional) {
this(tag, desc, acceptableValues, optional, SINGLE_VALUED, PUBLIC);
}
/**
* constructor - creates a public
* number parameter whose value must be one of the specified values,
* and which is required or optional and/or multi-valued, as specified.
*
* @param tag the tag associated with this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param acceptableValues the acceptable values for the parameter
* @param optional {@link Parameter#OPTIONAL OPTIONAL} if
* optional,
* {@link Parameter#REQUIRED REQUIRED} if required
* @param multiValued {@link Parameter#MULTI_VALUED MULTI_VALUED} if
* the parameter can accept multiple values,
* {@link Parameter#SINGLE_VALUED SINGLE_VALUED}
* if the parameter can contain only a single value
* @throws IllegalArgumentException if any parameter is
* invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see #setAcceptableDates(Date[]) setAcceptableDates()
* @see Parameter#OPTIONAL OPTIONAL
* @see Parameter#REQUIRED REQUIRED
* @see Parameter#SINGLE_VALUED SINGLE_VALUED
* @see Parameter#MULTI_VALUED MULTI_VALUED
*/
public DateTimeParam(String tag,
String desc,
Date[] acceptableValues,
boolean optional,
boolean multiValued) {
this(tag, desc, acceptableValues, optional, multiValued, PUBLIC);
}
/**
* constructor - creates a
* Parameter, all of whose options are specified.
*
* @param tag the tag associated with this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param acceptableValues the acceptable values for the parameter
* @param optional {@link Parameter#OPTIONAL OPTIONAL} if
* optional,
* {@link Parameter#REQUIRED REQUIRED} if required
* @param multiValued {@link Parameter#MULTI_VALUED MULTI_VALUED} if
* the parameter can accept multiple values,
* {@link Parameter#SINGLE_VALUED SINGLE_VALUED}
* if the parameter can contain only a single value
* @param hidden {@link Parameter#HIDDEN HIDDEN} if parameter is
* not to be listed in the usage,
* {@link Parameter#PUBLIC PUBLIC} otherwise.
* @throws IllegalArgumentException if any parameter is
* invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see #setAcceptableDates(Date[]) setAcceptableDates()
* @see Parameter#OPTIONAL OPTIONAL
* @see Parameter#REQUIRED REQUIRED
* @see Parameter#SINGLE_VALUED SINGLE_VALUED
* @see Parameter#MULTI_VALUED MULTI_VALUED
* @see Parameter#HIDDEN HIDDEN
* @see Parameter#PUBLIC PUBLIC
*/
public DateTimeParam(String tag,
String desc,
Date[] acceptableValues,
boolean optional,
boolean multiValued,
boolean hidden) {
this.setTag(tag);
this.setAcceptableDates(acceptableValues);
this.setDesc(desc);
this.setOptional(optional);
this.setMultiValued(multiValued);
this.setHidden(hidden);
this.setOptionLabel(sDateFmt + " " + sTimeFmtDisplay);
}
/**
* Verifies that value is valid for this entity - called by
* add/setValue(s)().
*
* @param value the value to be validated
* @throws CmdLineException if value is not valid.
*/
public void validateValue(String val) throws CmdLineException {
super.validateValue(val);
try {
stringToDate(val);
} catch (ParseException e) {
throw new CmdLineException(Strings.get(
"DateTimeParam.invalidDate",
new Object[] { getTag(), sDateFmt + " " + sTimeFmtDisplay }));
}
}
/**
* Returns the value of this Parameter as a java.util.Date object.
* Should there be more than one value for this Parameter, the first
* value will be returned.
*
* @return the value of this Parameter as a Date object
*/
public Date getDate() {
String sVal = getValue();
Date date = null;
if (sVal != null) {
try {
date = stringToDate(sVal);
} catch (ParseException e) {
// Should never get here because all values would have been
// parsed as part of validateValue().
throw new RuntimeException(e);
}
}
return date;
}
/**
* Returns the values of this Parameter as java.util.Date objects.
*
* @return The values of this Parameter as Date objects. Note
* the the return value may be an empty array if no
* values have been set.
*/
public Date[] getDates() {
Collection sVals = getValues();
Date[] dates = new Date[sVals.size()];
int i = 0;
for (Iterator itr = sVals.iterator(); itr.hasNext(); ) {
try {
dates[i] = stringToDate((String)itr.next());
i++;
} catch (ParseException e) {
// Should never get here because all values would have been
// parsed as part of validateValue().
throw new RuntimeException(e);
}
}
return dates;
}
/**
* Sets the seconds default to use if not specified by the user.
* This will default to 0 if never specified for a DateTimeParam object.
*
* @param defaultSeconds the seconds default to use if not specified
* by the user
* @see #getDefaultSeconds()
*/
public void setDefaultSeconds(int defaultSeconds) {
this.defaultSeconds = defaultSeconds;
}
/**
* Gets the seconds default to use if not specified by the user.
* This will default to 0 if never specified for a DateTimeParam object.
*
* @return the seconds default to use if not specified by
* the user
* @see #setDefaultSeconds(int) setDefaultSeconds()
*/
public int getDefaultSeconds() {
return defaultSeconds;
}
/**
* Sets the default millisecond value to use if not specified by the user.
* This will default to 0 if never specified for a DateTimeParam object.
*
* @param defaultMilliSeconds the default millisecond value to use if
* not specified by the user
* @see #getDefaultMilliSeconds()
*/
public void setDefaultMilliSeconds(int defaultMilliSeconds) {
this.defaultMilliSeconds = defaultMilliSeconds;
}
/**
* Gets the default millisecond value to use if not specified by the user.
* This will default to 0 if never specified for a DateTimeParam object.
*
* @return the default millisecond value to use if not
* specified by the user
* @see #setDefaultMilliSeconds(int) setDefaultMilliSeconds()
*/
public int getDefaultMilliSeconds() {
return defaultMilliSeconds;
}
/**
* Gets the format used to parse the date/time values.
*
* @return the format used to parse the date/time values
*/
public static String getParseFormat() {
return dateFmt.toLocalizedPattern();
}
/**
* Sets the values that will be acceptable for this Parameter using
* Date objects.
*
* @param dates an array of acceptable dates
*/
public void setAcceptableDates(Date[] dates) {
String[] sDates = new String[dates.length];
for (int i = 0; i < dates.length; i++) {
sDates[i] = dateFmt.format(dates[i]);
}
super.setAcceptableValues(sDates);
}
/**
* Gets the acceptable values as Date objects.
*
* @return The acceptable values as an array of Date objects.
* Note that null is returned if acceptable
* values have not been set.
*/
public Date[] getAcceptableDates() {
String[] sVals = getAcceptableValues();
if (sVals == null) {
return null;
}
Date[] dates = new Date[sVals.length];
for (int i = 0; i < sVals.length; i++) {
try {
dates[i] = stringToDate(sVals[i]);
} catch (Exception e) {
// should never get here - acceptable values parsed on the
// way in
throw new RuntimeException(e);
}
}
return dates;
}
/**
* Sets acceptable values for this Parameter.
*
* @param vals a Collection of java.util.Date objects representing
* the acceptable values.
* @throws ClassCastException if any member of vals is not
* a Date object.
*/
public void setAcceptableDates(Collection vals) {
String[] sVals = new String[vals.size()];
int i = 0;
for (Iterator itr = vals.iterator(); itr.hasNext(); ) {
date = (Date)itr.next();
sVals[i] = dateFmt.format(date);
i++;
}
super.setAcceptableValues(sVals);
}
/**
* Unsupported. This method is unsupported because, with the date format
* coming from a resource bundle, it is not reasonable to code string
* values for acceptable values - better to use Date objects.
*
* @throws UnsupportedOperationException;
* @see #setAcceptableDates(Date[])
* @see #setAcceptableDates(Collection)
*/
public void setAcceptableValues(Collection vals) {
throw new UnsupportedOperationException();
}
/**
* Unsupported. This method is unsupported because, with the date format
* coming from a resource bundle, it is not reasonable to code string
* values for acceptable values - better to use Date objects.
*
* @throws UnsupportedOperationException;
* @see #setAcceptableDates(Date[])
* @see #setAcceptableDates(Collection)
*/
public void setAcceptableValues(String[] vals) {
throw new UnsupportedOperationException();
}
/**
* Converts a String value to its Date equivalent, filling in default
* seconds and milliseconds as necessary.
*
* @param val the String to be converted
* @return the Date object represented by val
* @throws ParseException if val will not parse to a Date.
*/
private Date stringToDate(String val) throws ParseException {
if (val.length() == sDateFmt.length() + 6) {
val = val + ":" + secondFmt.format(defaultSeconds);
}
if (val.length() == sDateFmt.length() + 9) {
val = val + ":" + msFmt.format(defaultMilliSeconds);
}
return dateFmt.parse(val);
}
}
pdfsam-1.1.4/jcmdline/src/java/jcmdline/TextUsageFormatter.java 0000644 0001750 0001750 00000030213 10722536244 024453 0 ustar twerner twerner /*
* TextUsageFormatter.java
*
* Classes:
* public TextUsageFormatter
*
* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (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.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is the Java jcmdline (command line management) package.
*
* The Initial Developer of the Original Code is Lynne Lawrence.
*
* Portions created by the Initial Developer are Copyright (C) 2002
* the Initial Developer. All Rights Reserved.
*
* Contributor(s): Lynne Lawrence
*
* ***** END LICENSE BLOCK *****
*/
package jcmdline;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
/**
* Used to format a command's usage.
*
* @author Lynne Lawrence
* @version jcmdline Rel. @VERSION@ $Id: TextUsageFormatter.java,v 1.2 2002/12/07 14:22:06 lglawrence Exp $
* @see CmdLineHandler
*/
public class TextUsageFormatter implements UsageFormatter {
/**
* the maximum line length to use for usage display - defaults to 80.
* @see #setLineLength(int) setLineLength()
* @see #getLineLength()
*/
private int lineLength = 80;
/**
* a Helper for usage formatting
*/
private StringFormatHelper sHelper = StringFormatHelper.getHelper();
/**
* constructor
*/
public TextUsageFormatter () {
}
/**
* gets the usage for the command
*
* @param cmdName the command name
* @param cmdDesc the command description
* @param opts a Map of command options; keys are the option
* tags, values are the option objects
* @param args the command arguments
* @param showHidden if true, hidden parameters will be
* displayed
* @return the usage for the command
*/
public String formatUsage(String cmdName,
String cmdDesc,
Map opts,
List args,
boolean showHidden) {
String s;
int maxExpectedStringLen = 2048;
StringBuffer sb = new StringBuffer(maxExpectedStringLen);
// Format command name and description
s = sHelper.formatHangingIndent(cmdName + " - " + cmdDesc,
cmdName.length() + 3,
lineLength);
sb.append(s + "\n\n");
// Format options and arguments
int lineStartIdx = sb.length();
sb.append(Strings.get("TextUsageFormatter.usage"))
.append(" ")
.append(cmdName)
.append(" ");
if (opts.size() > 0) {
sb.append(haveRequiredOpt(opts)
? Strings.get("TextUsageFormatter.usageWReqOpt")
: Strings.get("TextUsageFormatter.usageWOReqOpt"))
.append(" ");
}
if (args.size() > 0) {
StringBuffer sb2 = argsOnOneLine(args, showHidden);
if (sb.length() - lineStartIdx + sb2.length() > lineLength) {
sb2 = argsOnSeparateLines(args,
sb.length() - lineStartIdx,
showHidden);
}
sb.append(sb2.toString())
.append("\n")
.append(getArgDescriptions(args, showHidden));
}
if (opts.size() > 0) {
sb.append("\n\n");
if (args.size() > 0) {
sb.append(Strings.get("TextUsageFormatter.optIntroWArgs"));
} else {
sb.append(Strings.get("TextUsageFormatter.optIntroNoArgs"));
}
sb.append("\n\n")
.append(getOptDescriptions(opts, showHidden));
sb.append("\n\n")
.append(sHelper.formatHangingIndent(
Strings.get("TextUsageFormatter.stdOptionHelp"),
0, lineLength));
}
return sb.toString();
}
/**
* Gets an error message, reformatted in a manner to "go well with"
* the usage statement. This implementation returns:
*
* ERROR: invalid filename
*
* when called as:
*
* formatErrorMsg("invalid filename")
*
*
* @param msg the text of the error message
* @return the reformatted error message
*/
public String formatErrorMsg(String msg) {
String error = Strings.get("TextUsageFormatter.errorPrefix");
return sHelper.formatHangingIndent(error + " " + msg,
error.length() + 1,
lineLength);
}
public String formatText(String text, int indent, int lineLen) {
return sHelper.formatBlockedText(text, indent, lineLen);
}
/**
* Sets the maximum line length to use for usage display - default is 80.
*
* @param lineLength the maximum line length to use for usage display
* @see #getLineLength()
*/
public void setLineLength(int lineLength) {
this.lineLength = lineLength;
}
/**
* Gets the maximum line length to use for usage display.
*
* @return the maximum line length to use for usage display
* @see #setLineLength(int) setLineLength()
*/
public int getLineLength() {
return lineLength;
}
/**
* Returns true if any of the command line options are
* required.
*
* @return true if any option is required
*/
private boolean haveRequiredOpt(Map options) {
boolean haveRequiredOpt = false;
for (Iterator itr = options.values().iterator(); itr.hasNext(); ) {
if (!((Parameter) itr.next()).isOptional()) {
haveRequiredOpt = true;
break;
}
}
return haveRequiredOpt;
}
/**
* Get command line arguments, one per line, with each line but the
* first having the specified indent.
*
* @param indent the indent
* @return the formatted arguments
*/
private StringBuffer argsOnSeparateLines(List args,
int indent,
boolean showHidden) {
int maxExpectedStringLen = 240;
StringBuffer sb2 = new StringBuffer(maxExpectedStringLen);
Parameter p;
int optIdx = 0;
sb2 = new StringBuffer(maxExpectedStringLen);
for (Iterator itr = args.iterator(); itr.hasNext(); ) {
p = (Parameter) itr.next();
if (p.isHidden() && !showHidden) {
continue;
}
for (int i = 0; i < optIdx; i++) {
sb2.append(' ');
}
sb2.append(argTagToString(p)).append(" \\\n");
optIdx = indent;
}
// trim off trailing space, backslash, and newline
return sb2.delete(sb2.length() - 3, sb2.length());
}
/**
* Get command line arguments, all on one line
*
* @return the formatted arguments
*/
private StringBuffer argsOnOneLine(List args, boolean showHidden) {
int maxExpectedStringLen = 800;
StringBuffer sb2 = new StringBuffer(maxExpectedStringLen);
Parameter p;
for (Iterator itr = args.iterator(); itr.hasNext(); ) {
p = (Parameter) itr.next();
if (p.isHidden() && !showHidden) {
continue;
}
sb2.append(argTagToString(p)).append(" ");
}
// trim off trailing space
if (sb2.length() > 0) {
sb2.deleteCharAt(sb2.length() - 1);
}
return sb2;
}
/**
* Get a command line argument's tag, enclosing in brackets if optional,
* and twice, followed by '...', if multi-valued.
*
* @param p the argument
* @return the argument's tag, as a string
*/
private String argTagToString(Parameter p) {
int maxExpectedStringLen = 50;
StringBuffer sb2 = new StringBuffer(maxExpectedStringLen);
String argstr;
if (p.isOptional()) {
argstr = "[" + p.getTag() + "]";
} else {
argstr = p.getTag();
}
sb2.append(argstr);
if (p.isMultiValued()) {
sb2.append("," + argstr + "...");
}
return sb2.toString();
}
/**
* Gets the argument descriptions as a String.
*
* @param showHidden true if hidden arguments are to be included.
* @return the argument descriptions
*/
private String getArgDescriptions(List args, boolean showHidden) {
StringBuffer sb = new StringBuffer(1024);
Parameter p;
if (args.size() == 0) {
return "";
}
sb.append("\n")
.append(Strings.get("TextUsageFormatter.where"))
.append("\n\n");
ArrayList tags = new ArrayList(args.size());
ArrayList desc = new ArrayList(args.size());
for (Iterator itr = args.iterator(); itr.hasNext(); ) {
p = (Parameter) itr.next();
if (p.isHidden() && !showHidden) {
continue;
}
tags.add(p.getTag());
desc.add(p.getDesc() + " (" +
((p.isOptional())
? Strings.get("TextUsageFormatter.optional")
: Strings.get("TextUsageFormatter.required"))
+ ")" +
((p.isHidden())
? (" (" +
Strings.get("TextUsageFormatter.hidden") + ")")
: ""));
}
sb.append(sHelper.formatLabeledList(
(String[])tags.toArray(new String[tags.size()]),
(String[])desc.toArray(new String[desc.size()]),
" = ",
20,
lineLength));
// remove trailing newline
return sb.deleteCharAt(sb.length() - 1).toString();
}
/**
* Gets the option descriptions as a String.
*
* @param showHidden true if hidden options are to be included.
* @return the option descriptions
*/
private String getOptDescriptions(Map options, boolean showHidden) {
if (options.size() == 0) {
return "";
}
ArrayList sortedOptions = new ArrayList(options.keySet());
Collections.sort(sortedOptions);
ArrayList labels = new ArrayList(options.size());
ArrayList desc = new ArrayList(options.size());
Parameter p;
for (Iterator itr = sortedOptions.iterator(); itr.hasNext(); ) {
p = (Parameter) options.get(itr.next());
if (p.isHidden() && !showHidden) {
continue;
}
labels.add("-" + p.getTag() + " " + p.getOptionLabel());
desc.add(p.getDesc() + " (" +
((p.isOptional())
? Strings.get("TextUsageFormatter.optional")
: Strings.get("TextUsageFormatter.required"))
+ ")" +
((p.isHidden())
? (" (" +
Strings.get("TextUsageFormatter.hidden") + ")")
: ""));
}
StringBuffer sb = new StringBuffer(
(sHelper.formatLabeledList(
(String[])labels.toArray(new String[labels.size()]),
(String[])desc.toArray(new String[desc.size()]),
" ",
20,
lineLength)));
// remove trailing newline
return sb.deleteCharAt(sb.length() - 1).toString();
}
}
pdfsam-1.1.4/jcmdline/src/java/jcmdline/OptionTakesNoValue.java 0000644 0001750 0001750 00000003433 10201471366 024407 0 ustar twerner twerner /*
* OptionTakesNoValue.java
*
* Classes:
* public OptionTakesNoValue
*
* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (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.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is the Java jcmdline (command line management) package.
*
* The Initial Developer of the Original Code is Lynne Lawrence.
*
* Portions created by the Initial Developer are Copyright (C) 2002
* the Initial Developer. All Rights Reserved.
*
* Contributor(s): Lynne Lawrence
*
* ***** END LICENSE BLOCK *****
*/
package jcmdline;
/**
* An interface indicating an option Paramter that requires no value on the
* command line (as for the BooleanParam).
*
* When Parmeters implementing this interface are be used as command
* line options, they may be specified in two ways:
*
* -optTag
* or
* -optTag=value
*
* If the first style is used, the option Parameter is passed the return
* value of {@link #getDefaultValue()} as its value.
*
* Specification of an option Paramter as:
*
* -optTag value
*
* is not valid, and will cause parse errors.
*
* @author Lynne Lawrence
* @version jcmdline Rel. @VERSION@ $Id: OptionTakesNoValue.java,v 1.2 2002/12/07 14:22:06 lglawrence Exp $
*/
public interface OptionTakesNoValue {
public String getDefaultValue();
}
pdfsam-1.1.4/jcmdline/src/java/jcmdline/DateParam.java 0000644 0001750 0001750 00000055677 10722330400 022523 0 ustar twerner twerner /*
* DateParam.java
*
* jcmdline Rel. @VERSION@ $Id: DateParam.java,v 1.2 2002/12/07 14:22:06 lglawrence Exp $
*
* Classes:
* public DateParam
*
* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (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.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is the Java jcmdline (command line management) package.
*
* The Initial Developer of the Original Code is Lynne Lawrence.
*
* Portions created by the Initial Developer are Copyright (C) 2002
* the Initial Developer. All Rights Reserved.
*
* Contributor(s): Lynne Lawrence
*
* ***** END LICENSE BLOCK *****
*/
package jcmdline;
import java.text.DecimalFormat;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Collection;
import java.util.Date;
import java.util.Iterator;
/**
* A parameter that accepts a date as its value.
*
* The format for the date is taken from the strings
* ResourceBundle.
*
* Sample Usage:
*
* DateParam startDateParam =
* new DateParam("startDate",
* "start date of report",
* DateParam.REQUIRED);
* DateParam endDateParam =
* new DateParam("endDate",
* "end date of report",
* DateParam.REQUIRED);
*
* // Time for startDate will be the beginning of the day by default.
* // Set the time for the end of the report to be the end of the day.
* endDateParam.setDefaultTime(23, 59, 58, 999);
*
* CmdLineHandler cl = new DefaultCmdLineHandler(
* "myreport", "report of activity over days",
* new Parameter[] {},
* new Parameter[] { startDateParam, endDateParam });
*
* cl.parse();
*
* // Don't need to check isSet() because params are REQUIRED
* Date stDate = startDateParam.getDate();
* Date enDate = endDateParam.getDate();
* .
* .
*
*
* @author Lynne Lawrence
* @version jcmdline Rel. @VERSION@ $Id: DateParam.java,v 1.2 2002/12/07 14:22:06 lglawrence Exp $
* @see DateTimeParam
* @see TimeParam
*/
public class DateParam extends AbstractParameter {
private static final String sDateFmt =
Strings.get("DateParam.dateFormat");
private static final String sTimeFmt = "HH:mm:ss:SSS";
private static final SimpleDateFormat dateFmt =
new SimpleDateFormat(sDateFmt);
private static final SimpleDateFormat dateFmtWTime =
new SimpleDateFormat(sDateFmt + " " + sTimeFmt);
private static final DecimalFormat hmsFmt = new DecimalFormat("00");
private static final DecimalFormat msFmt = new DecimalFormat("000");
private Date date = null;
/**
* The default hours to be added to the date - defaults to 0
* @see #setDefaultTime(int,int,int,int) setDefaultTime()
* @see #getDefaultTime()
*/
private int defaultHours = 0;
/**
* The default minutes to be added to the date - defaults to 0
* @see #setDefaultTime(int,int,int,int) setDefaultTime()
* @see #getDefaultTime()
*/
private int defaultMinutes = 0;
/**
* The default seconds to be added to the date - defaults to 0
* @see #setDefaultTime(int,int,int,int) setDefaultTime()
* @see #getDefaultTime()
*/
private int defaultSeconds = 0;
/**
* The default milliseconds to be added to the date - defaults to 0
* @see #setDefaultTime(int,int,int,int) setDefaultTime()
* @see #getDefaultTime()
*/
private int defaultMilliSeconds = 0;
/**
* constructor - creates single-valued, optional, public
* parameter
*
* @param tag a unique identifier for this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @throws IllegalArgumentException if tag
* or are invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
*/
public DateParam(String tag, String desc) {
this(tag, desc, OPTIONAL, SINGLE_VALUED, PUBLIC);
}
/**
* constructor - creates single-valued, public parameter which will
* will be either optional or required, as specified.
*
* @param tag a unique identifier for this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param optional {@link Parameter#OPTIONAL OPTIONAL} if
* optional,
* {@link Parameter#REQUIRED REQUIRED} if required
* @throws IllegalArgumentException if any of the specified
* parameters are invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
*/
public DateParam(String tag, String desc, boolean optional) {
this(tag, desc, optional, SINGLE_VALUED, PUBLIC);
}
/**
* constructor - creates a public parameter which will
* will be either optional or required, and/or multi-valued, as specified.
*
* @param tag a unique identifier for this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param optional {@link Parameter#OPTIONAL OPTIONAL} if
* optional,
* {@link Parameter#REQUIRED REQUIRED} if required
* @param multiValued {@link Parameter#MULTI_VALUED MULTI_VALUED} if
* the parameter can accept multiple values,
* {@link Parameter#SINGLE_VALUED SINGLE_VALUED}
* if the parameter can contain only a single value
* @throws IllegalArgumentException if any of the specified
* parameters are invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see Parameter#SINGLE_VALUED SINGLE_VALUED
* @see Parameter#MULTI_VALUED MULTI_VALUED
*/
public DateParam(String tag,
String desc,
boolean optional,
boolean multiValued) {
this(tag, desc, optional, multiValued, PUBLIC);
}
/**
* constructor - creates a parameter which will
* will be either optional or required, single or multi-valued, and
* hidden or public as specified.
*
* @param tag a unique identifier for this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param optional {@link Parameter#OPTIONAL OPTIONAL} if
* optional,
* {@link Parameter#REQUIRED REQUIRED} if required
* @param multiValued {@link Parameter#MULTI_VALUED MULTI_VALUED} if
* the parameter can accept multiple values,
* {@link Parameter#SINGLE_VALUED SINGLE_VALUED}
* if the parameter can contain only a single value
* @param hidden {@link Parameter#HIDDEN HIDDEN} if parameter is
* not to be listed in the usage,
* {@link Parameter#PUBLIC PUBLIC} otherwise.
* @throws IllegalArgumentException if any of the specified
* parameters are invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see Parameter#SINGLE_VALUED SINGLE_VALUED
* @see Parameter#MULTI_VALUED MULTI_VALUED
* @see Parameter#HIDDEN HIDDEN
* @see Parameter#PUBLIC PUBLIC
*/
public DateParam(String tag,
String desc,
boolean optional,
boolean multiValued,
boolean hidden) {
this.setTag(tag);
this.setDesc(desc);
this.setOptional(optional);
this.setMultiValued(multiValued);
this.setHidden(hidden);
this.setOptionLabel(sDateFmt);
}
/**
* constructor - creates a single-valued, optional, public,
* number parameter whose value must be one of the specified values.
*
* @param tag the tag associated with this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param acceptableValues the acceptable values for the parameter
* @throws IllegalArgumentException if any parameter is
* invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see #setAcceptableDates(Date[]) setAcceptableDates()
*/
public DateParam(String tag, String desc, Date[] acceptableValues) {
this(tag, desc, acceptableValues, OPTIONAL, SINGLE_VALUED, PUBLIC);
}
/**
* constructor - creates a single-valued, public,
* number parameter whose value must be one of the specified values,
* and which is required or optional, as specified.
*
* @param tag the tag associated with this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param acceptableValues the acceptable values for the parameter
* @param optional {@link Parameter#OPTIONAL OPTIONAL} if
* optional,
* {@link Parameter#REQUIRED REQUIRED} if required
* @throws IllegalArgumentException if any parameter is
* invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see #setAcceptableDates(Date[]) setAcceptableDates()
* @see Parameter#OPTIONAL OPTIONAL
* @see Parameter#REQUIRED REQUIRED
*/
public DateParam(String tag,
String desc,
Date[] acceptableValues,
boolean optional) {
this(tag, desc, acceptableValues, optional, SINGLE_VALUED, PUBLIC);
}
/**
* constructor - creates a public
* number parameter whose value must be one of the specified values,
* and which is required or optional and/or multi-valued, as specified.
*
* @param tag the tag associated with this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param acceptableValues the acceptable values for the parameter
* @param optional {@link Parameter#OPTIONAL OPTIONAL} if
* optional,
* {@link Parameter#REQUIRED REQUIRED} if required
* @param multiValued {@link Parameter#MULTI_VALUED MULTI_VALUED} if
* the parameter can accept multiple values,
* {@link Parameter#SINGLE_VALUED SINGLE_VALUED}
* if the parameter can contain only a single value
* @throws IllegalArgumentException if any parameter is
* invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see #setAcceptableDates(Date[]) setAcceptableDates()
* @see Parameter#OPTIONAL OPTIONAL
* @see Parameter#REQUIRED REQUIRED
* @see Parameter#SINGLE_VALUED SINGLE_VALUED
* @see Parameter#MULTI_VALUED MULTI_VALUED
*/
public DateParam(String tag,
String desc,
Date[] acceptableValues,
boolean optional,
boolean multiValued) {
this(tag, desc, acceptableValues, optional, multiValued, PUBLIC);
}
/**
* constructor - creates a
* Parameter, all of whose options are specified.
*
* @param tag the tag associated with this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param acceptableValues the acceptable values for the parameter
* @param optional {@link Parameter#OPTIONAL OPTIONAL} if
* optional,
* {@link Parameter#REQUIRED REQUIRED} if required
* @param multiValued {@link Parameter#MULTI_VALUED MULTI_VALUED} if
* the parameter can accept multiple values,
* {@link Parameter#SINGLE_VALUED SINGLE_VALUED}
* if the parameter can contain only a single value
* @param hidden {@link Parameter#HIDDEN HIDDEN} if parameter is
* not to be listed in the usage,
* {@link Parameter#PUBLIC PUBLIC} otherwise.
* @throws IllegalArgumentException if any parameter is
* invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see #setAcceptableDates(Date[]) setAcceptableDates()
* @see Parameter#OPTIONAL OPTIONAL
* @see Parameter#REQUIRED REQUIRED
* @see Parameter#SINGLE_VALUED SINGLE_VALUED
* @see Parameter#MULTI_VALUED MULTI_VALUED
* @see Parameter#HIDDEN HIDDEN
* @see Parameter#PUBLIC PUBLIC
*/
public DateParam(String tag,
String desc,
Date[] acceptableValues,
boolean optional,
boolean multiValued,
boolean hidden) {
this.setTag(tag);
this.setAcceptableDates(acceptableValues);
this.setDesc(desc);
this.setOptional(optional);
this.setMultiValued(multiValued);
this.setHidden(hidden);
this.setOptionLabel(sDateFmt);
}
/**
* Verifies that value is valid for this entity - called by
* add/setValue(s)().
*
* @param value the value to be validated
* @throws CmdLineException if value is not valid.
*/
public void validateValue(String val) throws CmdLineException {
super.validateValue(val);
try {
stringToDate(val);
} catch (ParseException e) {
throw new CmdLineException(Strings.get(
"DateParam.invalidDate",
new Object[] { getTag(), sDateFmt }));
}
}
/**
* Returns the value of this Parameter as a java.util.Date object.
* Should there be more than one value for this Parameter, the first
* value will be returned.
*
* @return the value of this Parameter as a Date object
*/
public Date getDate() {
String sVal = getValue();
Date date = null;
if (sVal != null) {
try {
date = stringToDate(sVal);
} catch (ParseException e) {
// Should never get here because all values would have been
// parsed as part of validateValue().
throw new RuntimeException(e);
}
}
return date;
}
/**
* Returns the values of this Parameter as java.util.Date objects.
*
* @return The values of this Parameter as Date objects. Note
* the the return value may be an empty array if no
* values have been set.
*/
public Date[] getDates() {
Collection sVals = getValues();
Date[] dates = new Date[sVals.size()];
int i = 0;
for (Iterator itr = sVals.iterator(); itr.hasNext(); ) {
try {
dates[i] = stringToDate((String)itr.next());
i++;
} catch (ParseException e) {
// Should never get here because all values would have been
// parsed as part of validateValue().
throw new RuntimeException(e);
}
}
return dates;
}
/**
* Gets the format used to parse the date/time values.
*
* @return the format used to parse the date/time values
*/
public static String getParseFormat() {
return dateFmt.toLocalizedPattern();
}
/**
* Sets the values that will be acceptable for this Parameter using
* Date objects. Any time portion of the Date objects will be stripped.
*
* @param dates an array of acceptable dates
*/
public void setAcceptableDates(Date[] dates) {
String[] sDates = new String[dates.length];
for (int i = 0; i < dates.length; i++) {
sDates[i] = dateFmt.format(dates[i]);
}
super.setAcceptableValues(sDates);
}
/**
* Gets the acceptable values as Date objects.
*
* @return The acceptable values as an array of Date objects.
* Note that null is returned if acceptable
* values have not been set.
*/
public Date[] getAcceptableDates() {
String[] sVals = getAcceptableValues();
if (sVals == null) {
return null;
}
Date[] dates = new Date[sVals.length];
for (int i = 0; i < sVals.length; i++) {
try {
dates[i] = stringToDate(sVals[i]);
} catch (Exception e) {
// should never get here - acceptable values parsed on the
// way in
throw new RuntimeException(e);
}
}
return dates;
}
/**
* Sets acceptable values for this Parameter from a Collection of
* Date objects. Any time portion of the Date objects will be stripped.
*
* @param vals a Collection of java.util.Date objects representing
* the acceptable values.
* @throws ClassCastException if any member of vals is not
* a Date object.
*/
public void setAcceptableDates(Collection vals) {
String[] sVals = new String[vals.size()];
int i = 0;
for (Iterator itr = vals.iterator(); itr.hasNext(); ) {
date = (Date)itr.next();
sVals[i] = dateFmt.format(date);
i++;
}
super.setAcceptableValues(sVals);
}
/**
* Unsupported. This method is unsupported because, with the date format
* coming from a resource bundle, it is not reasonable to code string
* values for acceptable values - better to use Date objects.
*
* @throws UnsupportedOperationException
* @see #setAcceptableDates(Date[])
* @see #setAcceptableDates(Collection)
*/
public void setAcceptableValues(Collection vals) {
throw new UnsupportedOperationException();
}
/**
* Unsupported. This method is unsupported because, with the date format
* coming from a resource bundle, it is not reasonable to code string
* values for acceptable values - better to use Date objects.
*
* @throws UnsupportedOperationException
* @see #setAcceptableDates(Date[])
* @see #setAcceptableDates(Collection)
*/
public void setAcceptableValues(String[] vals) {
throw new UnsupportedOperationException();
}
/**
* Sets default values for the time component used to generate the Date
* value.
*
* @param h the hours - 0-23 - defaults to 0
* @param m the minutes - 0-59 - defaults to 0
* @param s the seconds - 0-59 - defaults to 0
* @param ms the milliseconds - 0-999 - defaults to 0
* @throws IllegalArgumentException if any of the parameters are in
* error.
*/
public void setDefaultTime(int h, int m, int s, int ms) {
if (h < 0 || h > 23) {
throw new IllegalArgumentException(Strings.get(
"DateParam.invalidHours", new Object[] { new Integer(h) }));
}
if (m < 0 || m > 59) {
throw new IllegalArgumentException(Strings.get(
"DateParam.invalidMinutes", new Object[] { new Integer(m) }));
}
if (s < 0 || s > 59) {
throw new IllegalArgumentException(Strings.get(
"DateParam.invalidSeconds", new Object[] { new Integer(s) }));
}
if (ms < 0 || ms > 999) {
throw new IllegalArgumentException(Strings.get(
"DateParam.invalidMilliSeconds",
new Object[] { new Integer(ms) }));
}
defaultHours = h;
defaultMinutes = m;
defaultSeconds = s;
defaultMilliSeconds = ms;
}
/**
* Gets default values for the time component used to generate the Date
* value.
*
* @return a 4 element int array, where the elements are
* the default hours, minutes, seconds, and milliseconds, in
* that order
*/
public int[] getDefaultTime() {
return new int[] { defaultHours, defaultMinutes,
defaultSeconds, defaultMilliSeconds };
}
/**
* Converts a String value to its Date equivalent, filling in default
* seconds and milliseconds as necessary.
*
* @param val the String to be converted
* @return the Date object represented by val
* @throws ParseException if val will not parse to a Date.
*/
private Date stringToDate(String val) throws ParseException {
String sTime = hmsFmt.format(defaultHours) + ":" +
hmsFmt.format(defaultMinutes) + ":" +
hmsFmt.format(defaultSeconds) + ":" +
msFmt.format(defaultMilliSeconds);
return dateFmtWTime.parse(val + " " + sTime);
}
}
pdfsam-1.1.4/jcmdline/src/java/jcmdline/UsageFormatter.java 0000644 0001750 0001750 00000005375 10201471366 023614 0 ustar twerner twerner /*
* UsageFormatter.java
*
* Classes:
* public UsageFormatter
*
* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (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.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is the Java jcmdline (command line management) package.
*
* The Initial Developer of the Original Code is Lynne Lawrence.
*
* Portions created by the Initial Developer are Copyright (C) 2002
* the Initial Developer. All Rights Reserved.
*
* Contributor(s): Lynne Lawrence
*
* ***** END LICENSE BLOCK *****
*/
package jcmdline;
import java.util.List;
import java.util.Map;
/**
* Used to format a command's usage.
*
* @author Lynne Lawrence
* @version jcmdline Rel. @VERSION@ $Id: UsageFormatter.java,v 1.2 2002/12/07 14:22:06 lglawrence Exp $
* @see CmdLineHandler
*/
public interface UsageFormatter {
/**
* gets the usage for the command
*
* @param showHidden if true, hidden parameters will be
* displayed
* @return the usage for the command
*/
public String formatUsage(String cmdName,
String cmdDesc,
Map opts,
List args,
boolean showHidden) ;
/**
* Gets an error message, reformatted in a manner to "go well with"
* the usage statement. For instance,
*
* formatErrorMsg("invalid filename")
*
* Might return:
*
* ERROR: invalid filename
*
*
* @param msg the text of the error message
* @return the reformatted error message
*/
public String formatErrorMsg(String msg) ;
/**
* Sets the maximum line length to use for usage display. The maximum
* line length defaults to 80 if this method is not called to set it
* otherwise.
*
* @param lineLength the maximum line length to use for usage display
* @see #getLineLength()
*/
public void setLineLength(int lineLength) ;
/**
* Gets the maximum line length to use for usage display.
*
* @return the maximum line length to use for usage display
* @see #setLineLength(int) setLineLength()
*/
public int getLineLength() ;
}
pdfsam-1.1.4/jcmdline/src/java/jcmdline/FileParam.java 0000644 0001750 0001750 00000051525 10711667534 022534 0 ustar twerner twerner /*
* FileParam.java
*
* Classes:
* public FileParam
*
* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (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.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is the Java jcmdline (command line management) package.
*
* The Initial Developer of the Original Code is Lynne Lawrence.
*
* Portions created by the Initial Developer are Copyright (C) 2002
* the Initial Developer. All Rights Reserved.
*
* Contributor(s): Lynne Lawrence
*
* ***** END LICENSE BLOCK *****
*/
package jcmdline;
import java.io.File;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
/**
* Encapsulate a command line parameter whose value will be the name of
* a file or directory. Attributes, such as whether the value is to be
* a file or directory, whether it must be readable, etc, may be specified
* and will be validated.
*
* Usage:
*
* public static void main(String[] args) {
*
* FileParam filesArg =
* new FileParam("file",
* "a file to be processed - defaults to stdin",
* FileParam.IS_FILE & FileParam.IS_READABLE,
* FileParam.OPTIONAL,
* FileParam.MULTI_VALUED);
*
* CmdLineHandler cl =
* new VersionCmdLineHandler("V 1.0",
* "echoFiles",
* "echos specified files to stdout",
* new Parameter[] {},
* new Parameter[] { filesArg } ));
*
* cl.parse(args);
*
* if (filesArg.isSet()) {
* for (Iterator itr = filesArg.getFiles().iterator();
* itr.hasNext();) {
* processStream(new FileInputStream((File)itr.next()));
* }
* } else {
* processStream(System.in);
* }
* }
*
*
* @author Lynne Lawrence
* @version jcmdline Rel. @VERSION@ $Id: FileParam.java,v 1.2 2002/12/07 14:22:06 lglawrence Exp $
* @see CmdLineParser
*/
public class FileParam extends AbstractParameter {
// Note: attributes are specified with kind of a "reverse map" so
// that they can be "ANDed" together when set, which is more natural
// since that is the way they are processed.
/**
* indicates that no file/dir attributes are required or will be checked
* @see #setAttributes(int) setAttributes()
*/
public static final int NO_ATTRIBUTES = 0xffff;
/**
* indicates that a file or directory specified as a value for this
* FileParam must exist
* @see #setAttributes(int) setAttributes()
*/
public static final int EXISTS = 0xfffe;
/**
* indicates that a file or directory specified as a value for this
* FileParam must not exist
* @see #setAttributes(int) setAttributes()
*/
public static final int DOESNT_EXIST = 0xfffd;
/**
* indicates that a value specified for this FileParam must name an
* existing file
* @see #setAttributes(int) setAttributes()
*/
public static final int IS_FILE = 0xfffb;
/**
* indicates that a value specified for this FileParam must name an
* existing directory
* @see #setAttributes(int) setAttributes()
*/
public static final int IS_DIR = 0xfff7;
/**
* indicates that a value specified for this FileParam must name an
* existing file or directory for which the caller has read access
* @see #setAttributes(int) setAttributes()
*/
public static final int IS_READABLE = 0xffef;
/**
* indicates that a value specified for this FileParam must name an
* existing file or directory for which the caller has write access
* @see #setAttributes(int) setAttributes()
*/
public static final int IS_WRITEABLE = 0xffdf;
/**
* the default label that will represent option values for this Parameter
* where {@link #IS_DIR} is not set.
* The following demonstrates a possible usage for a FileParam option,
* where the option label is '<file>':
*
* out <file> the output file
*
* @see AbstractParameter#setOptionLabel(String) setOptionLabel()
* @see "FileParam.defaultFileOptionLabel in 'strings' properties
* file"
*/
public static final String DEFAULT_FILE_OPTION_LABEL =
Strings.get("FileParam.defaultFileOptionLabel");
/**
* the default label that will represent option values for this Parameter
* where {@link #IS_DIR} is set. The following demonstrates a possible
* usage for a FileParam option, where the option label is
* '<dir>':
*
* out <dir> the directory in which files will be created
*
* @see AbstractParameter#setOptionLabel(String) setOptionLabel()
* @see "FileParam.defaultDirOptionLabel in 'strings' properties
* file"
*/
public static final String DEFAULT_DIR_OPTION_LABEL =
Strings.get("FileParam.defaultDirOptionLabel");
/**
* Attributes which a file/directory value must have
* @see #setAttributes(int) setAttributes()
* @see #getAttributes()
*/
private int attributes;
/**
* constructor - creates single-valued, optional, public parameter
* which accepts any valid file or directory name as its value
*
* @param tag a unique identifier for this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @throws IllegalArgumentException if tag
* or are invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
*/
public FileParam(String tag, String desc) {
this(tag, desc, NO_ATTRIBUTES, OPTIONAL, SINGLE_VALUED, PUBLIC);
}
/**
* constructor - creates single-valued, public parameter which accepts
* any valid file or directory name as its value and is optional or
* required, as specified.
*
* @param tag a unique identifier for this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param optional {@link Parameter#OPTIONAL OPTIONAL} if
* optional,
* {@link Parameter#REQUIRED REQUIRED} if required
* @throws IllegalArgumentException if any of the specified
* parameters are invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see Parameter#OPTIONAL OPTIONAL
* @see Parameter#REQUIRED REQUIRED
*/
public FileParam(String tag, String desc, boolean optional) {
this(tag, desc, NO_ATTRIBUTES, optional, SINGLE_VALUED, PUBLIC);
}
/**
* constructor - creates a single-valued, optional, public, parameter
* accepts a file or directory name with the specified attributes.
*
* @param tag a unique identifier for this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param attributes the attributes that must apply to a file or
* directory specified as a value to this FileParam
* @throws IllegalArgumentException if any parameter is
* invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see #setAttributes(int) setAttributes()
*/
public FileParam(String tag, String desc, int attributes) {
this(tag, desc, attributes, OPTIONAL, SINGLE_VALUED, PUBLIC);
}
/**
* constructor - creates a single-valued, public, parameter
* that accepts a file or directory name with the specified attributes,
* and which is required or optional, as specified.
*
* @param tag a unique identifier for this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param attributes the attributes that must apply to a file or
* directory specified as a value to this FileParam
* @param optional {@link Parameter#OPTIONAL OPTIONAL} if
* optional,
* {@link Parameter#REQUIRED REQUIRED} if required
* @throws IllegalArgumentException if any parameter is
* invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see #setAttributes(int) setAttributes()
* @see Parameter#OPTIONAL OPTIONAL
* @see Parameter#REQUIRED REQUIRED
*/
public FileParam(String tag,
String desc,
int attributes,
boolean optional) {
this(tag, desc, attributes, optional, SINGLE_VALUED, PUBLIC);
}
/**
* constructor - creates a public parameter that accepts a file or
* directory name with the specified attributes, and which is required
* or optional and/or multi-valued, as specified.
*
* @param tag a unique identifier for this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param attributes the attributes that must apply to a file or
* directory specified as a value to this FileParam
* @param optional {@link Parameter#OPTIONAL OPTIONAL} if
* optional,
* {@link Parameter#REQUIRED REQUIRED} if required
* @param multiValued {@link Parameter#MULTI_VALUED MULTI_VALUED} if
* the parameter can accept multiple values,
* {@link Parameter#SINGLE_VALUED SINGLE_VALUED}
* if the parameter can contain only a single value
* @throws IllegalArgumentException if any parameter is
* invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see #setAttributes(int) setAttributes()
* @see Parameter#OPTIONAL OPTIONAL
* @see Parameter#REQUIRED REQUIRED
* @see Parameter#SINGLE_VALUED SINGLE_VALUED
* @see Parameter#MULTI_VALUED MULTI_VALUED
*/
public FileParam(String tag,
String desc,
int attributes,
boolean optional,
boolean multiValued) {
this(tag, desc, attributes, optional, multiValued, PUBLIC);
}
/**
* constructor - creates a parameter that accepts a file or directory
* name with the specified attributes, and which is required or optional
* and/or multi-valued or hidden, as specified.
*
* If the IS_DIR attribute is specified, the option label for
* this FileParam will be set to {@link #DEFAULT_DIR_OPTION_LABEL},
* else it will be {@link #DEFAULT_FILE_OPTION_LABEL}.
*
* @param tag a unique identifier for this parameter
* @param desc a description of the parameter, suitable for display
* in a usage statement
* @param attributes the attributes that must apply to a file or
* directory specified as a value to this FileParam
* @param optional {@link Parameter#OPTIONAL OPTIONAL} if
* optional,
* {@link Parameter#REQUIRED REQUIRED} if required
* @param multiValued {@link Parameter#MULTI_VALUED MULTI_VALUED} if
* the parameter can accept multiple values,
* {@link Parameter#SINGLE_VALUED SINGLE_VALUED}
* if the parameter can contain only a single value
* @param hidden {@link Parameter#HIDDEN HIDDEN} if parameter is
* not to be listed in the usage,
* {@link Parameter#PUBLIC PUBLIC} otherwise.
* @throws IllegalArgumentException if any parameter is
* invalid.
* @see AbstractParameter#setTag(String) setTag()
* @see AbstractParameter#setDesc(String) setDesc()
* @see AbstractParameter#setOptionLabel(String) setOptionLabel()
* @see #setAttributes(int) setAttributes()
* @see Parameter#OPTIONAL OPTIONAL
* @see Parameter#REQUIRED REQUIRED
* @see Parameter#SINGLE_VALUED SINGLE_VALUED
* @see Parameter#MULTI_VALUED MULTI_VALUED
* @see Parameter#HIDDEN HIDDEN
* @see Parameter#PUBLIC PUBLIC
*/
public FileParam(String tag,
String desc,
int attributes,
boolean optional,
boolean multiValued,
boolean hidden) {
this.setTag(tag);
this.setAttributes(attributes);
this.setDesc(desc);
this.optional = optional;
this.multiValued = multiValued;
this.hidden = hidden;
this.setOptionLabel(attrSpecified(IS_DIR)
? DEFAULT_DIR_OPTION_LABEL
: DEFAULT_FILE_OPTION_LABEL);
}
/**
* Gets the value of the FileParam as a File object. If the FileParam is
* multi-valued, the first value is returned.
*
* @return the value as a File object
* @throws RuntimeException if the value of the FileParam
* has not been set.
* @see Parameter#isSet()
*/
public File getFile() {
if (!set) {
throw new RuntimeException(Strings.get(
"FileParam.valueNotSet", new Object[] { tag }));
}
return new File((String)values.get(0));
}
/**
* Gets the values of the FileParam as a Collection of File objects.
* If the FileParam has no values, an empty Collection is returned.
*
* @return a Collection of File objects, possibly empty
* @see Parameter#isSet()
*/
public Collection getFiles() {
ArrayList vals = new ArrayList(values.size());
for (Iterator itr = values.iterator(); itr.hasNext(); ) {
vals.add(new File((String)itr.next()));
}
return vals;
}
/**
* Validates a prospective value for the FileParam - called by
* add/setValue(s)(). All of the attributes are validated and the a
* CmdLineException is thrown if any are not satisfied.
*
* @param val the value to validate
* @throws CmdLineException if value is not valid.
* @see #setAttributes(int) setAttributes()
*/
public void validateValue(String val) throws CmdLineException {
super.validateValue(val);
File f = null;
try {
f = new File(val);
} catch (Exception e) {
throwIllegalValueException(val);
}
if (attrSpecified(IS_DIR) && !f.isDirectory()) {
throwIllegalValueException(val);
}
if (attrSpecified(IS_FILE) && !f.isFile()) {
throwIllegalValueException(val);
}
if (attrSpecified(EXISTS) && !f.exists()) {
throwIllegalValueException(val);
}
if (attrSpecified(DOESNT_EXIST) && f.exists()) {
throwIllegalValueException(val);
}
if (attrSpecified(IS_READABLE) && !f.canRead()) {
throwIllegalValueException(val);
}
if (attrSpecified(IS_WRITEABLE) && !f.canWrite()) {
throwIllegalValueException(val);
}
}
/**
* Indicates whether an attribute has been specified for this FileParam.
*
* @param attr one of {@link #NO_ATTRIBUTES}, {@link #EXISTS},
* {@link #DOESNT_EXIST}, {@link #IS_DIR},
* {@link #IS_FILE}, {@link #IS_READABLE}, or
* {@link #IS_WRITEABLE}
* @return true if the attribute is set,
* false if the attribute is not set or
* attr is not a valid attribute
*/
public boolean attrSpecified(int attr) {
if (!(attr == EXISTS ||
attr == NO_ATTRIBUTES ||
attr == DOESNT_EXIST ||
attr == IS_DIR ||
attr == IS_FILE ||
attr == IS_READABLE ||
attr == IS_WRITEABLE)) {
return false;
}
return (((attributes | attr) ^ 0xffff) != 0);
}
/**
* Sets the value of attributes. Multiple attributes may be specified
* by ANDing them together. If multiple attributes are specified,
* all conditions must be met for a parameter value to be considered
* valid. For example:
*
* FileParam fp = new FileParam("tempDir",
* "a directory in which temporary files can be stored",
* FileParam.IS_DIR & FileParam.IS_WRITEABLE);
*
* In this case, a valid parameter value would have to be both a
* directory and writeable.
*
* Specify NO_ATTRIBUTES if none of the other attributes is
* required.
*
* @param attributes a combination of {@link #NO_ATTRIBUTES},
* {@link #EXISTS},
* {@link #DOESNT_EXIST},
* {@link #IS_DIR}, {@link #IS_FILE},
* {@link #IS_READABLE}, and {@link #IS_WRITEABLE}
* @throws IllegalArgumentException if the attributes value
* is invalid.
* @see #getAttributes()
*/
public void setAttributes(int attributes) {
if ((attributes ^ 0xffff) >= ((IS_WRITEABLE ^ 0xffff) * 2)) {
throw new IllegalArgumentException(Strings.get(
"FileParam.invalidAttributes",
new Object[] { new Integer(attributes) }));
}
this.attributes = attributes;
}
/**
* gets the value of attributes
*
* @return The attributes specified for this FileParam
* @see #setAttributes(int) setAttributes()
*/
public int getAttributes() {
return attributes;
}
/**
* Throws a nicely formatted error message when an invalid value is
* attempted to be validated.
*
* @param val the value that failed validation
* @return doesn't - throws a CmdLineException
* @throws CmdLineException - that's its goal!
*/
private void throwIllegalValueException (String val)
throws CmdLineException {
String s1;
if (attrSpecified(IS_DIR)) {
s1 = Strings.get("FileParam.directory");
} else if (attrSpecified(IS_FILE)) {
s1 = Strings.get("FileParam.file");
} else {
s1 = Strings.get("FileParam.file_dir");
}
String s2;
if (attrSpecified(EXISTS) ||
attrSpecified(IS_DIR) ||
attrSpecified(IS_FILE) ||
attrSpecified(IS_READABLE) ||
attrSpecified(IS_WRITEABLE)) {
s2 = Strings.get("FileParam.an_existing");
} else {
s2 = Strings.get("FileParam.a");
}
String s3 = "";
if (attrSpecified(IS_READABLE)) {
if (attrSpecified(IS_WRITEABLE)) {
s3 = Strings.get("FileParam.readable_writeable");
} else {
s3 = Strings.get("FileParam.readable");
}
} else if (attrSpecified(IS_WRITEABLE)) {
s3 = Strings.get("FileParam.writeable");
}
throw new CmdLineException(Strings.get(
"FileParam.illegalValue", new Object[] { s2, s1, s3, val, tag }));
}
}
pdfsam-1.1.4/jcmdline/src/java/jcmdline/VersionCmdLineHandler.java 0000644 0001750 0001750 00000017311 10201471366 025034 0 ustar twerner twerner /*
* VersionCmdLineHandler.java
*
* Classes:
* public VersionCmdLineHandler
*
* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (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.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is the Java jcmdline (command line management) package.
*
* The Initial Developer of the Original Code is Lynne Lawrence.
*
* Portions created by the Initial Developer are Copyright (C) 2002
* the Initial Developer. All Rights Reserved.
*
* Contributor(s): Lynne Lawrence
*
* ***** END LICENSE BLOCK *****
*/
package jcmdline;
import java.util.Collection;
/**
* A CmdLineHandler Decorator class that implements a -version option.
*
* The implemented option is a BooleanParam whose tag is defined by
* "VersionCmdLineHandler.version.tag" in the strings.properties
* file (set to "version", in English).
*
* Should the user specify this option on the command line, the command's
* version is printed to stdout, and System.exit(0) is called.
*
* Information on using CmdLineHandlers can be found in the jcmdline
* User Guide.
*
* @author Lynne Lawrence
* @version jcmdline Rel. @VERSION@ $Id: VersionCmdLineHandler.java,v 1.2 2002/12/07 14:22:06 lglawrence Exp $
* @see CmdLineHandler
* @see AbstractHandlerDecorator
*/
public class VersionCmdLineHandler extends AbstractHandlerDecorator {
/**
* a parameter that will cause the usage to be displayed
*/
private BooleanParam versionOpt;
/**
* the command's version
*/
private String version;
/**
* constructor
*
* @param version the command's version
* @param handler the CmdLineHandler to which most functionality
* will be delegated
* @throws IllegalArgumentException if version is null or
* empty.
*/
public VersionCmdLineHandler (String version, CmdLineHandler handler) {
super(handler);
if (version == null || version.length() == 0) {
throw new IllegalArgumentException(Strings.get(
"VersionCmdLineHandler.versionEmptyError"));
}
this.version = version;
versionOpt = new BooleanParam(
Strings.get("VersionCmdLineHandler.version.tag"),
Strings.get("VersionCmdLineHandler.version.desc"));
versionOpt.setIgnoreRequired(true);
setCustomOptions(new Parameter[] { versionOpt });
}
/**
* constructor - creates a new DefaultCmdLineHandler as its delegate
*
* @param version the command's version
* @param cmdName the name of the command
* @param cmdDesc a short description of the command
* @param options a collection of Parameter objects, describing the
* command's command-line options
* @param args a collection of Parameter objects, describing the
* command's command-line arguments (what is left on
* the command line after all options and their
* parameters have been processed)
* @param parser a CmdLineParser to be used to parse the command line
* @throws IllegalArgumentException if any of the
* parameters are not correctly specified.
* @see DefaultCmdLineHandler
*/
public VersionCmdLineHandler (String version,
String cmdName,
String cmdDesc,
Parameter[] options,
Parameter[] args,
CmdLineParser parser) {
this(version,
new DefaultCmdLineHandler(cmdName, cmdDesc, options, args, parser));
}
/**
* constructor - creates a new DefaultCmdLineHandler as its delegate
*
* @param version the command's version
* @param cmdName the name of the command
* @param cmdDesc a short description of the command
* @param options a collection of Parameter objects, describing the
* command's command-line options
* @param args a collection of Parameter objects, describing the
* command's command-line arguments (what is left on
* the command line after all options and their
* parameters have been processed)
* @throws IllegalArgumentException if any of the
* parameters are not correctly specified.
* @see DefaultCmdLineHandler
*/
public VersionCmdLineHandler (String version,
String cmdName,
String cmdDesc,
Parameter[] options,
Parameter[] args) {
this(version,
new DefaultCmdLineHandler(cmdName, cmdDesc, options, args));
}
/**
* constructor - uses the PosixCmdLineParser to parse the command line
*
* @param version the command's version
* @param cmdName the name of the command creating this
* DefaultCmdLineHandler
* @param cmdDesc a short description of the command's purpose
* @param options a collection of Parameter objects, describing the
* command's command-line options
* @param args a collection of Parameter objects, describing the
* command's command-line arguments (what is left on
* the command line after all options and their
* parameters have been processed)
* @throws IllegalArgumentException if any of the
* parameters are not correctly specified.
* @see #setCmdName(String) setCmdName()
* @see #setCmdDesc(String) setCmdDesc()
* @see #setOptions(Parameter[]) setOptions()
* @see PosixCmdLineParser
*/
public VersionCmdLineHandler (String version,
String cmdName,
String cmdDesc,
Collection options,
Collection args) {
this(version,
new DefaultCmdLineHandler(cmdName, cmdDesc, options, args));
}
/**
* Called following the call to parse() of this class's
* contained CmdLineHandler. This method only checks for its option if
* parseStatus is true.
*
* @param parseStatus The result of the parse() call to this
* class's contained CmdLineHandler.
* @return This method will call System.exit(0), rather
* than returning, if its option is set.
* Otherwise, parseStatus is returned.
*/
protected boolean processParsedOptions(boolean parseOk) {
if (parseOk) {
if (versionOpt.isTrue()) {
System.out.println(version);
System.exit(0);
}
}
return parseOk;
}
}
pdfsam-1.1.4/jcmdline/src/java/jcmdline/StringFormatHelper.java 0000644 0001750 0001750 00000026045 10201471366 024440 0 ustar twerner twerner /*
* StringFormatHelper.java
*
* jcmdline Rel. @VERSION@ $Id: StringFormatHelper.java,v 1.2 2002/12/07 14:22:06 lglawrence Exp $
*
* Classes:
* public StringFormatHelper
*
* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (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.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is the Java jcmdline (command line management) package.
*
* The Initial Developer of the Original Code is Lynne Lawrence.
*
* Portions created by the Initial Developer are Copyright (C) 2002
* the Initial Developer. All Rights Reserved.
*
* Contributor(s): Lynne Lawrence
*
* ***** END LICENSE BLOCK *****
*/
package jcmdline;
/**
* A class used to facilitate common String formatting tasks.
*
* Objects of this class contain no data. As such, this class is
* implemented as a Singleton.
*
* @author Lynne Lawrence
* @version jcmdline Rel. @VERSION@ $Id: StringFormatHelper.java,v 1.2 2002/12/07 14:22:06 lglawrence Exp $
*/
public class StringFormatHelper {
/**
* The one and only instance of the StringFormatHelper
*/
private static StringFormatHelper helper;
/**
* constructor - private
*/
private StringFormatHelper() {
}
/**
* Gets the one and only instance of the StringFormatHelper
* @return the one and only instance of the StringFormatHelper
*/
public static StringFormatHelper getHelper() {
if (helper == null) {
helper = new StringFormatHelper();
}
return helper;
}
/**
* Formats a string with a hanging indent.
*
The returned String is formated such that:
*
*
all lines it contains have length <= lineLen
*
all lines except for the first on are indented indent
* spaces
*
*
* @param indent the number of spaces to indent all but the
* first line (may be 0)
* @param lineLen the maximum line length
* @param s the string to be formatted
* @return the formatted string
* @throws IllegalArgumentException if lineLen is less than
* indent or if lineLen is less than 0.
*/
public String formatHangingIndent(String s, int indent, int lineLen) {
if (s == null || s.length() == 0) {
return "";
}
if (lineLen <= indent) {
throw new IllegalArgumentException(Strings.get(
"StringFormatHelper.lineLenLessThanIndent"));
}
if (lineLen <= 0) {
throw new IllegalArgumentException(Strings.get(
"StringFormatHelper.lineLenZero"));
}
// guesstimate required buffer length, leaving enough room for line
// terminators
StringBuffer sb = new StringBuffer(
s.length() + (s.length()/lineLen-indent) + 20);
String[] a = breakString(s, lineLen);
sb.append(a[0]);
if (a[1] != null) {
sb.append(formatBlockedText(a[1], indent, lineLen));
}
return sb.toString();
}
/**
* Splits the specified String into lines that are indented by the
* specified indent and are of length less than or equal to the
* specified line length.
*
* If s is null or empty, an empty String is returned.
*
* @param s the String to be formatted
* @param indent the length of the indent for the text block
* @param lineLen the maximum line length for the text block,
* including the indent
* @return the formatted text block
* @throws IllegalArgumentException if lineLen is less than
* indent or if lineLen is less than 0.
*/
public String formatBlockedText(String s, int indent, int lineLen) {
if (s == null || s.length() == 0) {
return "";
}
if (lineLen <= indent) {
throw new IllegalArgumentException(Strings.get(
"StringFormatHelper.lineLenLessThanIndent"));
}
if (lineLen <= 0) {
throw new IllegalArgumentException(Strings.get(
"StringFormatHelper.lineLenZero"));
}
// guesstimate required buffer length, leaving enough room for line
// terminators
StringBuffer sb = new StringBuffer(
s.length() + (s.length()/lineLen-indent) + 20);
StringBuffer indentBuf = new StringBuffer(indent);
for (int i = 0; i < indent; i++) {
indentBuf.append(" ");
}
int splitLen = lineLen - indent;
String[] a = breakString(s, splitLen);
while (a[1] != null) {
sb.append(indentBuf).append(a[0]);
a = breakString(a[1], splitLen);
}
sb.append(indentBuf).append(a[0]);
return sb.toString();
}
/**
* Breaks a String along word boundarys to the specified maximum length.
*
* This method returns an array of two strings:
*
* The first String is a line, of length less than maxLen.
* If this String is not the entire passed String, it will
* be terminated with a newline.
*
* The second String is the remainder of the original String. If the
* original String had been broken on a space (as opposed to a newline
* that had been in the original String) all leading spaces will have
* been removed. If there is no remainder, null is returned as the
* second String and no newline will have been appended to the first
* String.
*
* @param s The String to be broken. If null, will be
* converted to an empty string.
* @param maxLen the maximum line length of the first returned
* string
* @return see the method description
*/
protected String[] breakString(String s, int maxLen) {
s = (s == null) ? "" : s;
String line = null;
String remainder = null;
int idx;
if ((idx = s.indexOf('\n')) != -1 && idx <= maxLen) {
idx++; // point to next char
line = s.substring(0, idx);
if (idx < s.length()) {
remainder = s.substring(idx);
}
} else if (s.length() <= maxLen) {
line = s;
} else if ((idx = s.lastIndexOf(' ', maxLen)) != -1) {
line = s.substring(0, idx);
while (idx < s.length() && s.charAt(idx) == ' ') {
idx++;
}
if (idx < s.length()) {
line += "\n";
remainder = s.substring(idx);
}
} else {
line = s.substring(0, maxLen) + "\n";
remainder = s.substring(maxLen);
}
return new String[] { line, remainder };
}
/**
* Formats a "labeled list" (like a bullet or numbered list, only with
* labels for each item).
*
* Example:
*
* System.out.println(formatLabeledList(
* new String[] { "old_file", "new_file" },
* new String[] { "the name of the file to copy - this file " +
* "must already exist, be readable, and " +
* "end with '.html'",
* "the name of the file to receive the copy" },
* " = ", 20, 80));
*
* produces....
*
* old_file = the name of the file to copy - this file must already exist, be
* readable, and end with '.html'
* new_file = the name of the file to copy to
*
* Using the GNU gettext approach, compiled message catalogs are normal
* Java ResourceBundle classes and are thus interoperable with standard
* ResourceBundle based code.
*
* The main differences between the Sun ResourceBundle approach and the
* GNU gettext approach are:
*
*
In the Sun approach, the keys are abstract textual shortcuts.
* In the GNU gettext approach, the keys are the English/ASCII version
* of the messages.
*
In the Sun approach, the translation files are called
* "Resource_locale.properties" and have non-ASCII
* characters encoded in the Java
* \unnnn syntax. Very few editors
* can natively display international characters in this format. In the
* GNU gettext approach, the translation files are called
* "Resource.locale.po"
* and are in the encoding the translator has chosen. Many editors
* can be used. There are at least three GUI translating tools
* (Emacs PO mode, KDE KBabel, GNOME gtranslator).
*
In the Sun approach, the function
* ResourceBundle.getString throws a
* MissingResourceException when no translation is found.
* In the GNU gettext approach, the gettext function
* returns the (English) message key in that case.
*
In the Sun approach, there is no support for plural handling.
* Even the most elaborate MessageFormat strings cannot provide decent
* plural handling. In the GNU gettext approach, we have the
* ngettext function.
*