PdfVersionImp.java

/*
 * $Id: PdfVersionImp.java 3811 2009-03-23 18:15:13Z blowagie $
 *
 * Copyright 2006 Bruno Lowagie
 *
 * 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 'iText, a free JAVA-PDF library'.
 *
 * The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
 * the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
 * All Rights Reserved.
 * Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
 * are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
 *
 * Contributor(s): all the names of the contributors are added in the source code
 * where applicable.
 *
 * Alternatively, the contents of this file may be used under the terms of the
 * LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
 * provisions of LGPL are applicable instead of those above.  If you wish to
 * allow use of your version of this file only under the terms of the LGPL
 * License and not to allow others to use your version of this file under
 * the MPL, indicate your decision by deleting the provisions above and
 * replace them with the notice and other provisions required by the LGPL.
 * If you do not delete the provisions above, a recipient may use your version
 * of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
 *
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the MPL as stated above or under the terms of the GNU
 * Library General Public License as published by the Free Software Foundation;
 * either version 2 of the License, or any later version.
 *
 * This library 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 Library general Public License for more
 * details.
 *
 * If you didn't download this code from the following link, you should check if
 * you aren't using an obsolete version:
 * http://www.lowagie.com/iText/
 */

package com.lowagie.text.pdf.internal;

import java.io.IOException;

import com.lowagie.text.DocWriter;
import com.lowagie.text.pdf.OutputStreamCounter;
import com.lowagie.text.pdf.PdfDeveloperExtension;
import com.lowagie.text.pdf.PdfDictionary;
import com.lowagie.text.pdf.PdfName;
import com.lowagie.text.pdf.PdfWriter;
import com.lowagie.text.pdf.interfaces.PdfVersion;

/**
 * Stores the PDF version information,
 * knows how to write a PDF Header,
 * and how to add the version to the catalog (if necessary).
 */

public class PdfVersionImp implements PdfVersion {
    
    /** Contains different strings that are part of the header. */
    public static final byte[][] HEADER = {
        DocWriter.getISOBytes("\n"),
        DocWriter.getISOBytes("%PDF-"),
        DocWriter.getISOBytes("\n%\u00e2\u00e3\u00cf\u00d3\n")
    };
    
    /** Indicates if the header was already written. */
    protected boolean headerWasWritten = false;
    /** Indicates if we are working in append mode. */
    protected boolean appendmode = false;
    /** The version that was or will be written to the header. */
    protected char header_version = PdfWriter.VERSION_1_4;
    /** The version that will be written to the catalog. */
    protected PdfName catalog_version = null;
    /**
     * The extensions dictionary.
     * @since    2.1.6
     */
    protected PdfDictionary extensions = null;
    
    /**
     * @see com.lowagie.text.pdf.interfaces.PdfVersion#setPdfVersion(char)
     */
    public void setPdfVersion(char version) {
        if (headerWasWritten || appendmode) {
            setPdfVersion(getVersionAsName(version));
        }
        else {
            this.header_version = version;
        }
    }
    
    /**
     * @see com.lowagie.text.pdf.interfaces.PdfVersion#setAtLeastPdfVersion(char)
     */
    public void setAtLeastPdfVersion(char version) {
        if (version > header_version) {
            setPdfVersion(version);
        }
    }
    
    /**
     * @see com.lowagie.text.pdf.interfaces.PdfVersion#setPdfVersion(com.lowagie.text.pdf.PdfName)
     */
    public void setPdfVersion(PdfName version) {
        if (catalog_version == null || catalog_version.compareTo(version) < 0) {
            this.catalog_version = version;
        }
    }
    
    /**
     * Sets the append mode.
     */
    public void setAppendmode(boolean appendmode) {
        this.appendmode = appendmode;
    }
    
    /**
     * Writes the header to the OutputStreamCounter.
     * @throws IOException 
     */
    public void writeHeader(OutputStreamCounter os) throws IOException {
        if (appendmode) {
            os.write(HEADER[0]);
        }
        else {
            os.write(HEADER[1]);
            os.write(getVersionAsByteArray(header_version));
            os.write(HEADER[2]);
            headerWasWritten = true;
        }
    }
    
    /**
     * Returns the PDF version as a name.
     * @param version    the version character.
     */
    public PdfName getVersionAsName(char version) {
        switch(version) {
        case PdfWriter.VERSION_1_2:
            return PdfWriter.PDF_VERSION_1_2;
        case PdfWriter.VERSION_1_3:
            return PdfWriter.PDF_VERSION_1_3;
        case PdfWriter.VERSION_1_4:
            return PdfWriter.PDF_VERSION_1_4;
        case PdfWriter.VERSION_1_5:
            return PdfWriter.PDF_VERSION_1_5;
        case PdfWriter.VERSION_1_6:
            return PdfWriter.PDF_VERSION_1_6;
        case PdfWriter.VERSION_1_7:
            return PdfWriter.PDF_VERSION_1_7;
        default:
            return PdfWriter.PDF_VERSION_1_4;
        }
    }
    
    /**
     * Returns the version as a byte[].
     * @param version the version character
     */
    public byte[] getVersionAsByteArray(char version) {
        return DocWriter.getISOBytes(getVersionAsName(version).toString().substring(1));
    }

    /** Adds the version to the Catalog dictionary. */
    public void addToCatalog(PdfDictionary catalog) {
        if(catalog_version != null) {
            catalog.put(PdfName.VERSION, catalog_version);
        }
        if (extensions != null) {
            catalog.put(PdfName.EXTENSIONS, extensions);
        }
    }

    /**
     * @see com.lowagie.text.pdf.interfaces.PdfVersion#addDeveloperExtension(com.lowagie.text.pdf.PdfDeveloperExtension)
     * @since    2.1.6
     */
    public void addDeveloperExtension(PdfDeveloperExtension de) {
        if (extensions == null) {
            extensions = new PdfDictionary();
        }
        else {
            PdfDictionary extension = extensions.getAsDict(de.getPrefix());
            if (extension != null) {
                int diff = de.getBaseversion().compareTo(extension.getAsName(PdfName.BASEVERSION));
                if (diff < 0)
                    return;
                diff = de.getExtensionLevel() - extension.getAsNumber(PdfName.EXTENSIONLEVEL).intValue();
                if (diff <= 0)
                    return;
            }
        }
        extensions.put(de.getPrefix(), de.getDeveloperExtensions());
    }
}






























Active mutators

INCREMENTS_MUTATOR
VOID_METHOD_CALL_MUTATOR
RETURN_VALS_MUTATOR
MATH_MUTATOR
NEGATE_CONDITIONALS_MUTATOR
INVERT_NEGS_MUTATOR
CONDITIONALS_BOUNDARY_MUTATOR

Tests examined

Report generated by PIT 1.4.2

1		/*
2		* $Id: PdfVersionImp.java 3811 2009-03-23 18:15:13Z blowagie $
3		*
4		* Copyright 2006 Bruno Lowagie
5		*
6		* The contents of this file are subject to the Mozilla Public License Version 1.1
7		* (the "License"); you may not use this file except in compliance with the License.
8		* You may obtain a copy of the License at http://www.mozilla.org/MPL/
9		*
10		* Software distributed under the License is distributed on an "AS IS" basis,
11		* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
12		* for the specific language governing rights and limitations under the License.
13		*
14		* The Original Code is 'iText, a free JAVA-PDF library'.
15		*
16		* The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
17		* the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
18		* All Rights Reserved.
19		* Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
20		* are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
21		*
22		* Contributor(s): all the names of the contributors are added in the source code
23		* where applicable.
24		*
25		* Alternatively, the contents of this file may be used under the terms of the
26		* LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
27		* provisions of LGPL are applicable instead of those above. If you wish to
28		* allow use of your version of this file only under the terms of the LGPL
29		* License and not to allow others to use your version of this file under
30		* the MPL, indicate your decision by deleting the provisions above and
31		* replace them with the notice and other provisions required by the LGPL.
32		* If you do not delete the provisions above, a recipient may use your version
33		* of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
34		*
35		* This library is free software; you can redistribute it and/or modify it
36		* under the terms of the MPL as stated above or under the terms of the GNU
37		* Library General Public License as published by the Free Software Foundation;
38		* either version 2 of the License, or any later version.
39		*
40		* This library is distributed in the hope that it will be useful, but WITHOUT
41		* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
42		* FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
43		* details.
44		*
45		* If you didn't download this code from the following link, you should check if
46		* you aren't using an obsolete version:
47		* http://www.lowagie.com/iText/
48		*/
49
50		package com.lowagie.text.pdf.internal;
51
52		import java.io.IOException;
53
54		import com.lowagie.text.DocWriter;
55		import com.lowagie.text.pdf.OutputStreamCounter;
56		import com.lowagie.text.pdf.PdfDeveloperExtension;
57		import com.lowagie.text.pdf.PdfDictionary;
58		import com.lowagie.text.pdf.PdfName;
59		import com.lowagie.text.pdf.PdfWriter;
60		import com.lowagie.text.pdf.interfaces.PdfVersion;
61
62		/**
63		* Stores the PDF version information,
64		* knows how to write a PDF Header,
65		* and how to add the version to the catalog (if necessary).
66		*/
67
68		public class PdfVersionImp implements PdfVersion {
69
70		/** Contains different strings that are part of the header. */
71		public static final byte[][] HEADER = {
72		DocWriter.getISOBytes("\n"),
73		DocWriter.getISOBytes("%PDF-"),
74		DocWriter.getISOBytes("\n%\u00e2\u00e3\u00cf\u00d3\n")
75		};
76
77		/** Indicates if the header was already written. */
78		protected boolean headerWasWritten = false;
79		/** Indicates if we are working in append mode. */
80		protected boolean appendmode = false;
81		/** The version that was or will be written to the header. */
82		protected char header_version = PdfWriter.VERSION_1_4;
83		/** The version that will be written to the catalog. */
84		protected PdfName catalog_version = null;
85		/**
86		* The extensions dictionary.
87		* @since 2.1.6
88		*/
89		protected PdfDictionary extensions = null;
90
91		/**
92		* @see com.lowagie.text.pdf.interfaces.PdfVersion#setPdfVersion(char)
93		*/
94		public void setPdfVersion(char version) {
95	2 1. setPdfVersion : negated conditional → NO_COVERAGE 2. setPdfVersion : negated conditional → NO_COVERAGE	if (headerWasWritten \|\| appendmode) {
96	1 1. setPdfVersion : removed call to com/lowagie/text/pdf/internal/PdfVersionImp::setPdfVersion → NO_COVERAGE	setPdfVersion(getVersionAsName(version));
97		}
98		else {
99		this.header_version = version;
100		}
101		}
102
103		/**
104		* @see com.lowagie.text.pdf.interfaces.PdfVersion#setAtLeastPdfVersion(char)
105		*/
106		public void setAtLeastPdfVersion(char version) {
107	2 1. setAtLeastPdfVersion : changed conditional boundary → NO_COVERAGE 2. setAtLeastPdfVersion : negated conditional → NO_COVERAGE	if (version > header_version) {
108	1 1. setAtLeastPdfVersion : removed call to com/lowagie/text/pdf/internal/PdfVersionImp::setPdfVersion → NO_COVERAGE	setPdfVersion(version);
109		}
110		}
111
112		/**
113		* @see com.lowagie.text.pdf.interfaces.PdfVersion#setPdfVersion(com.lowagie.text.pdf.PdfName)
114		*/
115		public void setPdfVersion(PdfName version) {
116	3 1. setPdfVersion : changed conditional boundary → NO_COVERAGE 2. setPdfVersion : negated conditional → NO_COVERAGE 3. setPdfVersion : negated conditional → NO_COVERAGE	if (catalog_version == null \|\| catalog_version.compareTo(version) < 0) {
117		this.catalog_version = version;
118		}
119		}
120
121		/**
122		* Sets the append mode.
123		*/
124		public void setAppendmode(boolean appendmode) {
125		this.appendmode = appendmode;
126		}
127
128		/**
129		* Writes the header to the OutputStreamCounter.
130		* @throws IOException
131		*/
132		public void writeHeader(OutputStreamCounter os) throws IOException {
133	1 1. writeHeader : negated conditional → NO_COVERAGE	if (appendmode) {
134	1 1. writeHeader : removed call to com/lowagie/text/pdf/OutputStreamCounter::write → NO_COVERAGE	os.write(HEADER[0]);
135		}
136		else {
137	1 1. writeHeader : removed call to com/lowagie/text/pdf/OutputStreamCounter::write → NO_COVERAGE	os.write(HEADER[1]);
138	1 1. writeHeader : removed call to com/lowagie/text/pdf/OutputStreamCounter::write → NO_COVERAGE	os.write(getVersionAsByteArray(header_version));
139	1 1. writeHeader : removed call to com/lowagie/text/pdf/OutputStreamCounter::write → NO_COVERAGE	os.write(HEADER[2]);
140		headerWasWritten = true;
141		}
142		}
143
144		/**
145		* Returns the PDF version as a name.
146		* @param version the version character.
147		*/
148		public PdfName getVersionAsName(char version) {
149		switch(version) {
150		case PdfWriter.VERSION_1_2:
151	1 1. getVersionAsName : mutated return of Object value for com/lowagie/text/pdf/internal/PdfVersionImp::getVersionAsName to ( if (x != null) null else throw new RuntimeException ) → NO_COVERAGE	return PdfWriter.PDF_VERSION_1_2;
152		case PdfWriter.VERSION_1_3:
153	1 1. getVersionAsName : mutated return of Object value for com/lowagie/text/pdf/internal/PdfVersionImp::getVersionAsName to ( if (x != null) null else throw new RuntimeException ) → NO_COVERAGE	return PdfWriter.PDF_VERSION_1_3;
154		case PdfWriter.VERSION_1_4:
155	1 1. getVersionAsName : mutated return of Object value for com/lowagie/text/pdf/internal/PdfVersionImp::getVersionAsName to ( if (x != null) null else throw new RuntimeException ) → NO_COVERAGE	return PdfWriter.PDF_VERSION_1_4;
156		case PdfWriter.VERSION_1_5:
157	1 1. getVersionAsName : mutated return of Object value for com/lowagie/text/pdf/internal/PdfVersionImp::getVersionAsName to ( if (x != null) null else throw new RuntimeException ) → NO_COVERAGE	return PdfWriter.PDF_VERSION_1_5;
158		case PdfWriter.VERSION_1_6:
159	1 1. getVersionAsName : mutated return of Object value for com/lowagie/text/pdf/internal/PdfVersionImp::getVersionAsName to ( if (x != null) null else throw new RuntimeException ) → NO_COVERAGE	return PdfWriter.PDF_VERSION_1_6;
160		case PdfWriter.VERSION_1_7:
161	1 1. getVersionAsName : mutated return of Object value for com/lowagie/text/pdf/internal/PdfVersionImp::getVersionAsName to ( if (x != null) null else throw new RuntimeException ) → NO_COVERAGE	return PdfWriter.PDF_VERSION_1_7;
162		default:
163	1 1. getVersionAsName : mutated return of Object value for com/lowagie/text/pdf/internal/PdfVersionImp::getVersionAsName to ( if (x != null) null else throw new RuntimeException ) → NO_COVERAGE	return PdfWriter.PDF_VERSION_1_4;
164		}
165		}
166
167		/**
168		* Returns the version as a byte[].
169		* @param version the version character
170		*/
171		public byte[] getVersionAsByteArray(char version) {
172	1 1. getVersionAsByteArray : mutated return of Object value for com/lowagie/text/pdf/internal/PdfVersionImp::getVersionAsByteArray to ( if (x != null) null else throw new RuntimeException ) → NO_COVERAGE	return DocWriter.getISOBytes(getVersionAsName(version).toString().substring(1));
173		}
174
175		/** Adds the version to the Catalog dictionary. */
176		public void addToCatalog(PdfDictionary catalog) {
177	1 1. addToCatalog : negated conditional → NO_COVERAGE	if(catalog_version != null) {
178	1 1. addToCatalog : removed call to com/lowagie/text/pdf/PdfDictionary::put → NO_COVERAGE	catalog.put(PdfName.VERSION, catalog_version);
179		}
180	1 1. addToCatalog : negated conditional → NO_COVERAGE	if (extensions != null) {
181	1 1. addToCatalog : removed call to com/lowagie/text/pdf/PdfDictionary::put → NO_COVERAGE	catalog.put(PdfName.EXTENSIONS, extensions);
182		}
183		}
184
185		/**
186		* @see com.lowagie.text.pdf.interfaces.PdfVersion#addDeveloperExtension(com.lowagie.text.pdf.PdfDeveloperExtension)
187		* @since 2.1.6
188		*/
189		public void addDeveloperExtension(PdfDeveloperExtension de) {
190	1 1. addDeveloperExtension : negated conditional → NO_COVERAGE	if (extensions == null) {
191		extensions = new PdfDictionary();
192		}
193		else {
194		PdfDictionary extension = extensions.getAsDict(de.getPrefix());
195	1 1. addDeveloperExtension : negated conditional → NO_COVERAGE	if (extension != null) {
196		int diff = de.getBaseversion().compareTo(extension.getAsName(PdfName.BASEVERSION));
197	2 1. addDeveloperExtension : changed conditional boundary → NO_COVERAGE 2. addDeveloperExtension : negated conditional → NO_COVERAGE	if (diff < 0)
198		return;
199	1 1. addDeveloperExtension : Replaced integer subtraction with addition → NO_COVERAGE	diff = de.getExtensionLevel() - extension.getAsNumber(PdfName.EXTENSIONLEVEL).intValue();
200	2 1. addDeveloperExtension : changed conditional boundary → NO_COVERAGE 2. addDeveloperExtension : negated conditional → NO_COVERAGE	if (diff <= 0)
201		return;
202		}
203		}
204	1 1. addDeveloperExtension : removed call to com/lowagie/text/pdf/PdfDictionary::put → NO_COVERAGE	extensions.put(de.getPrefix(), de.getDeveloperExtensions());
205		}
206		}
		Mutations
95		1.1 Location : setPdfVersion Killed by : none negated conditional → NO_COVERAGE 2.2 Location : setPdfVersion Killed by : none negated conditional → NO_COVERAGE
96		1.1 Location : setPdfVersion Killed by : none removed call to com/lowagie/text/pdf/internal/PdfVersionImp::setPdfVersion → NO_COVERAGE
107		1.1 Location : setAtLeastPdfVersion Killed by : none changed conditional boundary → NO_COVERAGE 2.2 Location : setAtLeastPdfVersion Killed by : none negated conditional → NO_COVERAGE
108		1.1 Location : setAtLeastPdfVersion Killed by : none removed call to com/lowagie/text/pdf/internal/PdfVersionImp::setPdfVersion → NO_COVERAGE
116		1.1 Location : setPdfVersion Killed by : none changed conditional boundary → NO_COVERAGE 2.2 Location : setPdfVersion Killed by : none negated conditional → NO_COVERAGE 3.3 Location : setPdfVersion Killed by : none negated conditional → NO_COVERAGE
133		1.1 Location : writeHeader Killed by : none negated conditional → NO_COVERAGE
134		1.1 Location : writeHeader Killed by : none removed call to com/lowagie/text/pdf/OutputStreamCounter::write → NO_COVERAGE
137		1.1 Location : writeHeader Killed by : none removed call to com/lowagie/text/pdf/OutputStreamCounter::write → NO_COVERAGE
138		1.1 Location : writeHeader Killed by : none removed call to com/lowagie/text/pdf/OutputStreamCounter::write → NO_COVERAGE
139		1.1 Location : writeHeader Killed by : none removed call to com/lowagie/text/pdf/OutputStreamCounter::write → NO_COVERAGE
151		1.1 Location : getVersionAsName Killed by : none mutated return of Object value for com/lowagie/text/pdf/internal/PdfVersionImp::getVersionAsName to ( if (x != null) null else throw new RuntimeException ) → NO_COVERAGE
153		1.1 Location : getVersionAsName Killed by : none mutated return of Object value for com/lowagie/text/pdf/internal/PdfVersionImp::getVersionAsName to ( if (x != null) null else throw new RuntimeException ) → NO_COVERAGE
155		1.1 Location : getVersionAsName Killed by : none mutated return of Object value for com/lowagie/text/pdf/internal/PdfVersionImp::getVersionAsName to ( if (x != null) null else throw new RuntimeException ) → NO_COVERAGE
157		1.1 Location : getVersionAsName Killed by : none mutated return of Object value for com/lowagie/text/pdf/internal/PdfVersionImp::getVersionAsName to ( if (x != null) null else throw new RuntimeException ) → NO_COVERAGE
159		1.1 Location : getVersionAsName Killed by : none mutated return of Object value for com/lowagie/text/pdf/internal/PdfVersionImp::getVersionAsName to ( if (x != null) null else throw new RuntimeException ) → NO_COVERAGE
161		1.1 Location : getVersionAsName Killed by : none mutated return of Object value for com/lowagie/text/pdf/internal/PdfVersionImp::getVersionAsName to ( if (x != null) null else throw new RuntimeException ) → NO_COVERAGE
163		1.1 Location : getVersionAsName Killed by : none mutated return of Object value for com/lowagie/text/pdf/internal/PdfVersionImp::getVersionAsName to ( if (x != null) null else throw new RuntimeException ) → NO_COVERAGE
172		1.1 Location : getVersionAsByteArray Killed by : none mutated return of Object value for com/lowagie/text/pdf/internal/PdfVersionImp::getVersionAsByteArray to ( if (x != null) null else throw new RuntimeException ) → NO_COVERAGE
177		1.1 Location : addToCatalog Killed by : none negated conditional → NO_COVERAGE
178		1.1 Location : addToCatalog Killed by : none removed call to com/lowagie/text/pdf/PdfDictionary::put → NO_COVERAGE
180		1.1 Location : addToCatalog Killed by : none negated conditional → NO_COVERAGE
181		1.1 Location : addToCatalog Killed by : none removed call to com/lowagie/text/pdf/PdfDictionary::put → NO_COVERAGE
190		1.1 Location : addDeveloperExtension Killed by : none negated conditional → NO_COVERAGE
195		1.1 Location : addDeveloperExtension Killed by : none negated conditional → NO_COVERAGE
197		1.1 Location : addDeveloperExtension Killed by : none changed conditional boundary → NO_COVERAGE 2.2 Location : addDeveloperExtension Killed by : none negated conditional → NO_COVERAGE
199		1.1 Location : addDeveloperExtension Killed by : none Replaced integer subtraction with addition → NO_COVERAGE
200		1.1 Location : addDeveloperExtension Killed by : none changed conditional boundary → NO_COVERAGE 2.2 Location : addDeveloperExtension Killed by : none negated conditional → NO_COVERAGE
204		1.1 Location : addDeveloperExtension Killed by : none removed call to com/lowagie/text/pdf/PdfDictionary::put → NO_COVERAGE

PdfVersionImp.java

Mutations

Active mutators

Tests examined