Author: msahyoun
Date: Wed Dec 25 11:49:18 2019
New Revision: 1871962
URL: http://svn.apache.org/viewvc?rev=1871962&view=rev
Log:
PDFBOX-4669: port COSArrayList changes and unit test to trunk; use assertThrows
for exception testing
Added:
pdfbox/trunk/pdfbox/src/test/java/org/apache/pdfbox/pdmodel/common/COSArrayListTest.java
Modified:
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/COSArrayList.java
Modified:
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/COSArrayList.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/COSArrayList.java?rev=1871962&r1=1871961&r2=1871962&view=diff
==============================================================================
---
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/COSArrayList.java
(original)
+++
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/COSArrayList.java
Wed Dec 25 11:49:18 2019
@@ -43,6 +43,10 @@ public class COSArrayList<E> implements
private final COSArray array;
private final List<E> actual;
+ // indicates that the list has been filtered
+ // i.e. the number of entries in array and actual differ
+ private boolean isFiltered = false;
+
private COSDictionary parentDict;
private COSName dictKey;
@@ -56,8 +60,16 @@ public class COSArrayList<E> implements
}
/**
- * Constructor.
- *
+ * Create the COSArrayList specifing the List and the backing COSArray.
+ *
+ * <p>User of this constructor need to ensure that the entries in the List
and
+ * the backing COSArray are matching i.e. the COSObject of the List entry
is
+ * included in the COSArray.
+ *
+ * <p>If the number of entries in the List and the COSArray differ
+ * it is assumed that the List has been filtered. In that case the
COSArrayList
+ * shall only be used for reading purposes and no longer for updating.
+ *
* @param actualList The list of standard java objects
* @param cosArray The COS array object to sync to.
*/
@@ -65,6 +77,12 @@ public class COSArrayList<E> implements
{
actual = actualList;
array = cosArray;
+
+ // if the number of entries differs this may come from a filter being
+ // applied at the PDModel level
+ if (actual.size() != array.size()) {
+ isFiltered = true;
+ }
}
/**
@@ -200,6 +218,11 @@ public class COSArrayList<E> implements
@Override
public boolean remove(Object o)
{
+
+ if (isFiltered) {
+ throw new UnsupportedOperationException("removing entries from a
filtered List is not permitted");
+ }
+
boolean retval = true;
int index = actual.indexOf( o );
if( index >= 0 )
@@ -229,6 +252,10 @@ public class COSArrayList<E> implements
@Override
public boolean addAll(Collection<? extends E> c)
{
+ if (isFiltered) {
+ throw new UnsupportedOperationException("Apping to a filtered List
is not permitted");
+ }
+
//when adding if there is a parentDict then change the item
//in the dictionary from a single item to an array.
if( parentDict != null && c.size() > 0)
@@ -248,6 +275,10 @@ public class COSArrayList<E> implements
@Override
public boolean addAll(int index, Collection<? extends E> c)
{
+ if (isFiltered) {
+ throw new UnsupportedOperationException("Inserting to a filtered
List is not permitted");
+ }
+
//when adding if there is a parentDict then change the item
//in the dictionary from a single item to an array.
if( parentDict != null && c.size() > 0)
@@ -551,6 +582,10 @@ public class COSArrayList<E> implements
@Override
public E set(int index, E element)
{
+ if (isFiltered) {
+ throw new UnsupportedOperationException("Replacing an element in a
filtered List is not permitted");
+ }
+
if( element instanceof String )
{
COSString item = new COSString( (String)element );
@@ -577,6 +612,10 @@ public class COSArrayList<E> implements
@Override
public void add(int index, E element)
{
+ if (isFiltered) {
+ throw new UnsupportedOperationException("Adding an element in a
filtered List is not permitted");
+ }
+
//when adding if there is a parentDict then change the item
//in the dictionary from a single item to an array.
if( parentDict != null )
@@ -603,6 +642,10 @@ public class COSArrayList<E> implements
@Override
public E remove(int index)
{
+ if (isFiltered) {
+ throw new UnsupportedOperationException("removing entries from a
filtered List is not permitted");
+ }
+
array.remove( index );
return actual.remove( index );
}
Added:
pdfbox/trunk/pdfbox/src/test/java/org/apache/pdfbox/pdmodel/common/COSArrayListTest.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/test/java/org/apache/pdfbox/pdmodel/common/COSArrayListTest.java?rev=1871962&view=auto
==============================================================================
---
pdfbox/trunk/pdfbox/src/test/java/org/apache/pdfbox/pdmodel/common/COSArrayListTest.java
(added)
+++
pdfbox/trunk/pdfbox/src/test/java/org/apache/pdfbox/pdmodel/common/COSArrayListTest.java
Wed Dec 25 11:49:18 2019
@@ -0,0 +1,292 @@
+/*
+ * Copyright 2015 The Apache Software Foundation.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.pdfbox.pdmodel.common;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertThrows;
+import static org.junit.Assert.assertTrue;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+
+import org.apache.pdfbox.cos.COSArray;
+import org.apache.pdfbox.cos.COSBase;
+import org.apache.pdfbox.pdmodel.PDPage;
+import org.apache.pdfbox.pdmodel.interactive.annotation.AnnotationFilter;
+import org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation;
+import org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationCircle;
+import org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationHighlight;
+import org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink;
+import org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquare;
+import org.junit.Before;
+import org.junit.Test;
+
+public class COSArrayListTest {
+ // next two entries are to be used for comparison with
+ // COSArrayList behaviour in order to ensure that the
+ // intented object is now at the correct position.
+ // Will also be used for Collection/Array based setting
+ // and comparison
+ static List<PDAnnotation> tbcAnnotationsList;
+ static COSBase[] tbcAnnotationsArray;
+
+ // next entries are to be used within COSArrayList
+ static List<PDAnnotation> annotationsList;
+ static COSArray annotationsArray;
+
+ // to be used when testing retrieving filtered items as can be done with
+ // {@link PDPage.getAnnotations(AnnotationFilter annotationFilter)}
+ static PDPage pdPage;
+
+ /*
+ * Create thre new different annotations an add them to the Java
List/Array as
+ * well as PDFBox List/Array implementations.
+ */
+ @Before
+ public void setUp() throws Exception {
+ annotationsList = new ArrayList<PDAnnotation>();
+ PDAnnotationHighlight txtMark = new PDAnnotationHighlight();
+ PDAnnotationLink txtLink = new PDAnnotationLink();
+ PDAnnotationCircle aCircle = new PDAnnotationCircle();
+
+ annotationsList.add(txtMark);
+ annotationsList.add(txtLink);
+ annotationsList.add(aCircle);
+ annotationsList.add(txtLink);
+ assertTrue(annotationsList.size() == 4);
+
+ tbcAnnotationsList = new ArrayList<PDAnnotation>();
+ tbcAnnotationsList.add(txtMark);
+ tbcAnnotationsList.add(txtLink);
+ tbcAnnotationsList.add(aCircle);
+ tbcAnnotationsList.add(txtLink);
+ assertTrue(tbcAnnotationsList.size() == 4);
+
+ annotationsArray = new COSArray();
+ annotationsArray.add(txtMark);
+ annotationsArray.add(txtLink);
+ annotationsArray.add(aCircle);
+ annotationsArray.add(txtLink);
+ assertTrue(annotationsArray.size() == 4);
+
+ tbcAnnotationsArray = new COSBase[4];
+ tbcAnnotationsArray[0] = txtMark.getCOSObject();
+ tbcAnnotationsArray[1] = txtLink.getCOSObject();
+ tbcAnnotationsArray[2] = aCircle.getCOSObject();
+ tbcAnnotationsArray[3] = txtLink.getCOSObject();
+ assertTrue(tbcAnnotationsArray.length == 4);
+
+ // add the annotations to the page
+ pdPage = new PDPage();
+ pdPage.setAnnotations(annotationsList);
+ }
+
+ /**
+ * Test getting a PDModel element is in sync with underlying COSArray
+ */
+ @Test
+ public void getFromList() throws Exception {
+ COSArrayList<PDAnnotation> cosArrayList = new
COSArrayList<PDAnnotation>(annotationsList, annotationsArray);
+
+ for (int i = 0; i < cosArrayList.size(); i++) {
+ PDAnnotation annot = (PDAnnotation) cosArrayList.get(i);
+ assertTrue("PDAnnotations cosObject at " + i + " shall be equal to
index " + i + " of COSArray",
+ annotationsArray.get(i).equals(annot.getCOSObject()));
+
+ // compare with Java List/Array
+ assertTrue("PDAnnotations at " + i + " shall be at index " + i + "
of List",
+ tbcAnnotationsList.get(i).equals((annot)));
+ assertEquals("PDAnnotations cosObject at " + i + " shall be at
position " + i + " of Array",
+ tbcAnnotationsArray[i], annot.getCOSObject());
+ }
+ }
+
+ /**
+ * Test adding a PDModel element is in sync with underlying COSArray
+ */
+ @Test
+ public void addToList() throws Exception {
+ COSArrayList<PDAnnotation> cosArrayList = new
COSArrayList<PDAnnotation>(annotationsList, annotationsArray);
+
+ // add new annotation
+ PDAnnotationSquare aSquare = new PDAnnotationSquare();
+ cosArrayList.add(aSquare);
+
+ assertTrue("List size shall be 5", annotationsList.size() == 5);
+ assertTrue("COSArray size shall be 5", annotationsArray.size() == 5);
+
+ PDAnnotation annot = (PDAnnotation) annotationsList.get(4);
+ assertTrue("Added annotation shall be 4th entry in COSArray",
annotationsArray.indexOf(annot.getCOSObject()) == 4);
+ assertEquals("Provided COSArray and underlying COSArray shall be
equal", annotationsArray, cosArrayList.toList());
+ }
+
+ /**
+ * Test removing a PDModel element by index is in sync with underlying
COSArray
+ */
+ @Test
+ public void removeFromListByIndex() throws Exception {
+ COSArrayList<PDAnnotation> cosArrayList = new
COSArrayList<PDAnnotation>(annotationsList, annotationsArray);
+
+ int positionToRemove = 2;
+ PDAnnotation toBeRemoved = cosArrayList.get(positionToRemove);
+
+ assertEquals("Remove operation shall return the removed
object",toBeRemoved, cosArrayList.remove(positionToRemove));
+ assertTrue("List size shall be 3", cosArrayList.size() == 3);
+ assertTrue("COSArray size shall be 3", annotationsArray.size() == 3);
+
+ assertTrue("PDAnnotation shall no longer exist in List",
+ cosArrayList.indexOf(tbcAnnotationsList.get(positionToRemove)) ==
-1);
+ assertTrue("COSObject shall no longer exist in COSArray",
+ annotationsArray.indexOf(tbcAnnotationsArray[positionToRemove]) ==
-1);
+ }
+
+ /**
+ * Test removing a unique PDModel element by index is in sync with
underlying COSArray
+ */
+ @Test
+ public void removeUniqueFromListByObject() throws Exception {
+ COSArrayList<PDAnnotation> cosArrayList = new
COSArrayList<PDAnnotation>(annotationsList, annotationsArray);
+
+ int positionToRemove = 2;
+ PDAnnotation toBeRemoved = annotationsList.get(positionToRemove);
+
+ assertTrue("Remove operation shall return
true",cosArrayList.remove(toBeRemoved));
+ assertTrue("List size shall be 3", cosArrayList.size() == 3);
+ assertTrue("COSArray size shall be 3", annotationsArray.size() == 3);
+
+ // compare with Java List/Array to ensure correct object at position
+ assertTrue("List object at 3 is at position 2 in COSArrayList now",
+ cosArrayList.get(2).equals(tbcAnnotationsList.get(3)));
+ assertTrue("COSObject of List object at 3 is at position 2 in COSArray
now",
+
annotationsArray.get(2).equals(tbcAnnotationsList.get(3).getCOSObject()));
+ assertTrue("Array object at 3 is at position 2 in underlying COSArray
now",
+ annotationsArray.get(2).equals(tbcAnnotationsArray[3]));
+
+ assertTrue("PDAnnotation shall no longer exist in List",
+ cosArrayList.indexOf(tbcAnnotationsList.get(positionToRemove)) ==
-1);
+ assertTrue("COSObject shall no longer exist in COSArray",
+ annotationsArray.indexOf(tbcAnnotationsArray[positionToRemove]) ==
-1);
+
+ assertFalse("Remove shall not remove any
object",cosArrayList.remove(toBeRemoved));
+
+ }
+
+ /**
+ * Test removing a unique PDModel element by index is in sync with
underlying COSArray
+ */
+ @Test
+ public void removeAllUniqueFromListByObject() throws Exception {
+ COSArrayList<PDAnnotation> cosArrayList = new
COSArrayList<PDAnnotation>(annotationsList, annotationsArray);
+
+ int positionToRemove = 2;
+ PDAnnotation toBeRemoved = annotationsList.get(positionToRemove);
+
+ List<PDAnnotation> toBeRemovedInstances =
Collections.singletonList(toBeRemoved);
+
+ assertTrue("Remove operation shall return
true",cosArrayList.removeAll(toBeRemovedInstances));
+ assertTrue("List size shall be 3", cosArrayList.size() == 3);
+ assertTrue("COSArray size shall be 3", annotationsArray.size() == 3);
+
+ assertFalse("Remove shall not remove any
object",cosArrayList.removeAll(toBeRemovedInstances));
+ }
+
+
+ /**
+ * Test removing a multiple appearing PDModel element by index is in sync
with underlying COSArray
+ */
+ @Test
+ public void removeMultipleFromListByObject() throws Exception {
+ COSArrayList<PDAnnotation> cosArrayList = new
COSArrayList<PDAnnotation>(annotationsList, annotationsArray);
+
+ int positionToRemove = 1;
+ PDAnnotation toBeRemoved = tbcAnnotationsList.get(positionToRemove);
+
+ assertTrue("Remove operation shall return
true",cosArrayList.remove(toBeRemoved));
+ assertTrue("List size shall be 3", cosArrayList.size() == 3);
+ assertTrue("COSArray size shall be 3", annotationsArray.size() == 3);
+
+ assertTrue("Remove operation shall return
true",cosArrayList.remove(toBeRemoved));
+ assertTrue("List size shall be 2", cosArrayList.size() == 2);
+ assertTrue("COSArray size shall be 2", annotationsArray.size() == 2);
+
+ }
+
+ /**
+ * Test removing a unique PDModel element by index is in sync with
underlying COSArray
+ */
+ @Test
+ public void removeAllMultipleFromListByObject() throws Exception {
+ COSArrayList<PDAnnotation> cosArrayList = new
COSArrayList<PDAnnotation>(annotationsList, annotationsArray);
+
+ int positionToRemove = 1;
+ PDAnnotation toBeRemoved = annotationsList.get(positionToRemove);
+
+ List<PDAnnotation> toBeRemovedInstances =
Collections.singletonList(toBeRemoved);
+
+ assertTrue("Remove operation shall return
true",cosArrayList.removeAll(toBeRemovedInstances));
+ assertTrue("List size shall be 2", cosArrayList.size() == 2);
+ assertTrue("COSArray size shall be 2", annotationsArray.size() == 2);
+
+ assertFalse("Remove shall not remove any
object",cosArrayList.removeAll(toBeRemovedInstances));
+ }
+
+ @Test
+ public void removeFromFilteredListByIndex() throws Exception
+ {
+ // retrieve all annotations from page but the link annotation
+ // which is 2nd in list - see above setup
+ AnnotationFilter annotsFilter = new AnnotationFilter()
+ {
+ @Override
+ public boolean accept(PDAnnotation annotation)
+ {
+ return !(annotation instanceof PDAnnotationLink);
+ }
+ };
+
+ COSArrayList<PDAnnotation> cosArrayList = (COSArrayList<PDAnnotation>)
pdPage.getAnnotations(annotsFilter);
+
+ // this call should fail
+ assertThrows(UnsupportedOperationException.class, () ->
cosArrayList.remove(1));
+ }
+
+
+ @Test
+ public void removeFromFilteredListByObject() throws Exception
+ {
+ // retrieve all annotations from page but the link annotation
+ // which is 2nd in list - see above setup
+ AnnotationFilter annotsFilter = new AnnotationFilter()
+ {
+ @Override
+ public boolean accept(PDAnnotation annotation)
+ {
+ return !(annotation instanceof PDAnnotationLink);
+ }
+ };
+
+ COSArrayList<PDAnnotation> cosArrayList = (COSArrayList<PDAnnotation>)
pdPage.getAnnotations(annotsFilter);
+
+ // remove object
+ int positionToRemove = 1;
+ PDAnnotation toBeRemoved = cosArrayList.get(positionToRemove);
+
+ // this call should fail
+ assertThrows(UnsupportedOperationException.class, () ->
cosArrayList.remove(toBeRemoved));
+ }
+}
\ No newline at end of file
