PdfStructureElement.java

/*
 * $Id: PdfStructureElement.java 4065 2009-09-16 23:09:11Z psoares33 $
 *
 * Copyright 2005 by Paulo Soares.
 *
 * 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;

import com.lowagie.text.error_messages.MessageLocalization;

/**
 * This is a node in a document logical structure. It may contain a mark point or it may contain
 * other nodes.
 * @author Paulo Soares (psoares@consiste.pt)
 */
public class PdfStructureElement extends PdfDictionary {
    
    /**
     * Holds value of property kids.
     */
    private PdfStructureElement parent;
    private PdfStructureTreeRoot top;
    
    /**
     * Holds value of property reference.
     */
    private PdfIndirectReference reference;
    
    /**
     * Creates a new instance of PdfStructureElement.
     * @param parent the parent of this node
     * @param structureType the type of structure. It may be a standard type or a user type mapped by the role map
     */
    public PdfStructureElement(PdfStructureElement parent, PdfName structureType) {
        top = parent.top;
        init(parent, structureType);
        this.parent = parent;
        put(PdfName.P, parent.reference);
    }
    
    /**
     * Creates a new instance of PdfStructureElement.
     * @param parent the parent of this node
     * @param structureType the type of structure. It may be a standard type or a user type mapped by the role map
     */    
    public PdfStructureElement(PdfStructureTreeRoot parent, PdfName structureType) {
        top = parent;
        init(parent, structureType);
        put(PdfName.P, parent.getReference());
    }
    
    private void init(PdfDictionary parent, PdfName structureType) {
        PdfObject kido = parent.get(PdfName.K);
        PdfArray kids = null;
        if (kido != null && !kido.isArray())
            throw new IllegalArgumentException(MessageLocalization.getComposedMessage("the.parent.has.already.another.function"));
        if (kido == null) {
            kids = new PdfArray();
            parent.put(PdfName.K, kids);
        }
        else
            kids = (PdfArray)kido;
        kids.add(this);
        put(PdfName.S, structureType);
        reference = top.getWriter().getPdfIndirectReference();
    }
    
    /**
     * Gets the parent of this node.
     * @return the parent of this node
     */    
    public PdfDictionary getParent() {
        return parent;
    }
    
    void setPageMark(int page, int mark) {
        if (mark >= 0)
            put(PdfName.K, new PdfNumber(mark));
        top.setPageMark(page, reference);
    }
    
    /**
     * Gets the reference this object will be written to.
     * @return the reference this object will be written to
     * @since    2.1.6 method removed in 2.1.5, but restored in 2.1.6
     */    
    public PdfIndirectReference getReference() {
        return this.reference;
    }
}













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: PdfStructureElement.java 4065 2009-09-16 23:09:11Z psoares33 $
3		*
4		* Copyright 2005 by Paulo Soares.
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;
51
52		import com.lowagie.text.error_messages.MessageLocalization;
53
54		/**
55		* This is a node in a document logical structure. It may contain a mark point or it may contain
56		* other nodes.
57		* @author Paulo Soares (psoares@consiste.pt)
58		*/
59		public class PdfStructureElement extends PdfDictionary {
60
61		/**
62		* Holds value of property kids.
63		*/
64		private PdfStructureElement parent;
65		private PdfStructureTreeRoot top;
66
67		/**
68		* Holds value of property reference.
69		*/
70		private PdfIndirectReference reference;
71
72		/**
73		* Creates a new instance of PdfStructureElement.
74		* @param parent the parent of this node
75		* @param structureType the type of structure. It may be a standard type or a user type mapped by the role map
76		*/
77		public PdfStructureElement(PdfStructureElement parent, PdfName structureType) {
78		top = parent.top;
79	1 1. : removed call to com/lowagie/text/pdf/PdfStructureElement::init → NO_COVERAGE	init(parent, structureType);
80		this.parent = parent;
81	1 1. : removed call to com/lowagie/text/pdf/PdfStructureElement::put → NO_COVERAGE	put(PdfName.P, parent.reference);
82		}
83
84		/**
85		* Creates a new instance of PdfStructureElement.
86		* @param parent the parent of this node
87		* @param structureType the type of structure. It may be a standard type or a user type mapped by the role map
88		*/
89		public PdfStructureElement(PdfStructureTreeRoot parent, PdfName structureType) {
90		top = parent;
91	1 1. : removed call to com/lowagie/text/pdf/PdfStructureElement::init → NO_COVERAGE	init(parent, structureType);
92	1 1. : removed call to com/lowagie/text/pdf/PdfStructureElement::put → NO_COVERAGE	put(PdfName.P, parent.getReference());
93		}
94
95		private void init(PdfDictionary parent, PdfName structureType) {
96		PdfObject kido = parent.get(PdfName.K);
97		PdfArray kids = null;
98	2 1. init : negated conditional → NO_COVERAGE 2. init : negated conditional → NO_COVERAGE	if (kido != null && !kido.isArray())
99		throw new IllegalArgumentException(MessageLocalization.getComposedMessage("the.parent.has.already.another.function"));
100	1 1. init : negated conditional → NO_COVERAGE	if (kido == null) {
101		kids = new PdfArray();
102	1 1. init : removed call to com/lowagie/text/pdf/PdfDictionary::put → NO_COVERAGE	parent.put(PdfName.K, kids);
103		}
104		else
105		kids = (PdfArray)kido;
106		kids.add(this);
107	1 1. init : removed call to com/lowagie/text/pdf/PdfStructureElement::put → NO_COVERAGE	put(PdfName.S, structureType);
108		reference = top.getWriter().getPdfIndirectReference();
109		}
110
111		/**
112		* Gets the parent of this node.
113		* @return the parent of this node
114		*/
115		public PdfDictionary getParent() {
116		return parent;
117		}
118
119		void setPageMark(int page, int mark) {
120	2 1. setPageMark : changed conditional boundary → NO_COVERAGE 2. setPageMark : negated conditional → NO_COVERAGE	if (mark >= 0)
121	1 1. setPageMark : removed call to com/lowagie/text/pdf/PdfStructureElement::put → NO_COVERAGE	put(PdfName.K, new PdfNumber(mark));
122	1 1. setPageMark : removed call to com/lowagie/text/pdf/PdfStructureTreeRoot::setPageMark → NO_COVERAGE	top.setPageMark(page, reference);
123		}
124
125		/**
126		* Gets the reference this object will be written to.
127		* @return the reference this object will be written to
128		* @since 2.1.6 method removed in 2.1.5, but restored in 2.1.6
129		*/
130		public PdfIndirectReference getReference() {
131		return this.reference;
132		}
133		}
		Mutations
79		1.1 Location : Killed by : none removed call to com/lowagie/text/pdf/PdfStructureElement::init → NO_COVERAGE
81		1.1 Location : Killed by : none removed call to com/lowagie/text/pdf/PdfStructureElement::put → NO_COVERAGE
91		1.1 Location : Killed by : none removed call to com/lowagie/text/pdf/PdfStructureElement::init → NO_COVERAGE
92		1.1 Location : Killed by : none removed call to com/lowagie/text/pdf/PdfStructureElement::put → NO_COVERAGE
98		1.1 Location : init Killed by : none negated conditional → NO_COVERAGE 2.2 Location : init Killed by : none negated conditional → NO_COVERAGE
100		1.1 Location : init Killed by : none negated conditional → NO_COVERAGE
102		1.1 Location : init Killed by : none removed call to com/lowagie/text/pdf/PdfDictionary::put → NO_COVERAGE
107		1.1 Location : init Killed by : none removed call to com/lowagie/text/pdf/PdfStructureElement::put → NO_COVERAGE
120		1.1 Location : setPageMark Killed by : none changed conditional boundary → NO_COVERAGE 2.2 Location : setPageMark Killed by : none negated conditional → NO_COVERAGE
121		1.1 Location : setPageMark Killed by : none removed call to com/lowagie/text/pdf/PdfStructureElement::put → NO_COVERAGE
122		1.1 Location : setPageMark Killed by : none removed call to com/lowagie/text/pdf/PdfStructureTreeRoot::setPageMark → NO_COVERAGE

PdfStructureElement.java

Mutations

Active mutators

Tests examined