You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pdfbox.apache.org by le...@apache.org on 2021/03/14 14:50:03 UTC

svn commit: r1887633 - in /pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox: cos/ pdmodel/interactive/action/ pdmodel/interactive/annotation/ pdmodel/interactive/measurement/ pdmodel/interactive/pagenavigation/

Author: lehmi
Date: Sun Mar 14 14:50:02 2021
New Revision: 1887633

URL: http://svn.apache.org/viewvc?rev=1887633&view=rev
Log:
PDFBOX-4892: use convenience methods to simplify code, add new constants

Modified:
    pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSName.java
    pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/action/PDActionLaunch.java
    pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/action/PDDocumentCatalogAdditionalActions.java
    pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/annotation/PDAnnotationFileAttachment.java
    pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/measurement/PDRectlinearMeasureDictionary.java
    pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/pagenavigation/PDThread.java
    pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/pagenavigation/PDThreadBead.java

Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSName.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSName.java?rev=1887633&r1=1887632&r2=1887633&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSName.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSName.java Sun Mar 14 14:50:02 2021
@@ -91,6 +91,7 @@ public final class COSName extends COSBa
     public static final COSName BBOX = new COSName("BBox");
     public static final COSName BC = new COSName("BC");
     public static final COSName BE = new COSName("BE");
+    public static final COSName BEAD = new COSName("BEAD");
     public static final COSName BEFORE = new COSName("Before");
     public static final COSName BG = new COSName("BG");
     public static final COSName BITS_PER_COMPONENT = new COSName("BitsPerComponent");
@@ -271,6 +272,7 @@ public final class COSName extends COSBa
     public static final COSName FORM = new COSName("Form");
     public static final COSName FORMTYPE = new COSName("FormType");
     public static final COSName FRM = new COSName("FRM");
+    public static final COSName FS = new COSName("FS");
     public static final COSName FT = new COSName("FT");
     public static final COSName FUNCTION = new COSName("Function");
     public static final COSName FUNCTION_TYPE = new COSName("FunctionType");
@@ -547,6 +549,7 @@ public final class COSName extends COSBa
     public static final COSName T = new COSName("T");
     public static final COSName TARGET = new COSName("Target");
     public static final COSName TEMPLATES = new COSName("Templates");
+    public static final COSName THREAD = new COSName("Thread");
     public static final COSName THREADS = new COSName("Threads");
     public static final COSName THUMB = new COSName("Thumb");
     public static final COSName TI = new COSName("TI");
@@ -599,12 +602,16 @@ public final class COSName extends COSBa
     // W
     public static final COSName W = new COSName("W");
     public static final COSName W2 = new COSName("W2");
+    public static final COSName WC = new COSName("WC");
     public static final COSName WHITE_POINT = new COSName("WhitePoint");
     public static final COSName WIDGET = new COSName("Widget");
     public static final COSName WIDTH = new COSName("Width");
     public static final COSName WIDTHS = new COSName("Widths");
+    public static final COSName WIN = new COSName("Win");
     public static final COSName WIN_ANSI_ENCODING = new COSName("WinAnsiEncoding");
     public static final COSName WMODE = new COSName("WMode");
+    public static final COSName WP = new COSName("WP");
+    public static final COSName WS = new COSName("WS");
     // X
     public static final COSName X = new COSName("X");
     public static final COSName XFA = new COSName("XFA");
@@ -614,6 +621,7 @@ public final class COSName extends COSBa
     public static final COSName XREF = new COSName("XRef");
     public static final COSName XREF_STM = new COSName("XRefStm");
     // Y
+    public static final COSName Y = new COSName("Y");
     public static final COSName Y_STEP = new COSName("YStep");
     public static final COSName YES = new COSName("Yes");
 

Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/action/PDActionLaunch.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/action/PDActionLaunch.java?rev=1887633&r1=1887632&r2=1887633&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/action/PDActionLaunch.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/action/PDActionLaunch.java Sun Mar 14 14:50:02 2021
@@ -93,13 +93,8 @@ public class PDActionLaunch extends PDAc
      */
     public PDWindowsLaunchParams getWinLaunchParams()
     {
-        COSDictionary win = (COSDictionary)action.getDictionaryObject( "Win" );
-        PDWindowsLaunchParams retval = null;
-        if( win != null )
-        {
-            retval = new PDWindowsLaunchParams( win );
-        }
-        return retval;
+        COSDictionary win = action.getCOSDictionary(COSName.WIN);
+        return win != null ? new PDWindowsLaunchParams(win) : null;
     }
 
     /**
@@ -109,7 +104,7 @@ public class PDActionLaunch extends PDAc
      */
     public void setWinLaunchParams( PDWindowsLaunchParams win )
     {
-        action.setItem( "Win", win );
+        action.setItem(COSName.WIN, win);
     }
 
     /**

Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/action/PDDocumentCatalogAdditionalActions.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/action/PDDocumentCatalogAdditionalActions.java?rev=1887633&r1=1887632&r2=1887633&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/action/PDDocumentCatalogAdditionalActions.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/action/PDDocumentCatalogAdditionalActions.java Sun Mar 14 14:50:02 2021
@@ -17,6 +17,7 @@
 package org.apache.pdfbox.pdmodel.interactive.action;
 
 import org.apache.pdfbox.cos.COSDictionary;
+import org.apache.pdfbox.cos.COSName;
 import org.apache.pdfbox.pdmodel.common.COSObjectable;
 
 /**
@@ -68,13 +69,8 @@ public class PDDocumentCatalogAdditional
      */
     public PDAction getWC()
     {
-        COSDictionary wc = (COSDictionary)actions.getDictionaryObject( "WC" );
-        PDAction retval = null;
-        if( wc != null )
-        {
-            retval = PDActionFactory.createAction( wc );
-        }
-        return retval;
+        COSDictionary wc = actions.getCOSDictionary(COSName.WC);
+        return wc != null ? PDActionFactory.createAction(wc) : null;
     }
 
     /**
@@ -86,7 +82,7 @@ public class PDDocumentCatalogAdditional
      */
     public void setWC( PDAction wc )
     {
-        actions.setItem( "WC", wc );
+        actions.setItem(COSName.WC, wc);
     }
 
     /**
@@ -98,13 +94,8 @@ public class PDDocumentCatalogAdditional
      */
     public PDAction getWS()
     {
-        COSDictionary ws = (COSDictionary)actions.getDictionaryObject( "WS" );
-        PDAction retval = null;
-        if( ws != null )
-        {
-            retval = PDActionFactory.createAction( ws );
-        }
-        return retval;
+        COSDictionary ws = actions.getCOSDictionary(COSName.WS);
+        return ws != null ? PDActionFactory.createAction(ws) : null;
     }
 
     /**
@@ -116,7 +107,7 @@ public class PDDocumentCatalogAdditional
      */
     public void setWS( PDAction ws )
     {
-        actions.setItem( "WS", ws );
+        actions.setItem(COSName.WS, ws);
     }
 
     /**
@@ -128,13 +119,8 @@ public class PDDocumentCatalogAdditional
      */
     public PDAction getDS()
     {
-        COSDictionary ds = (COSDictionary)actions.getDictionaryObject( "DS" );
-        PDAction retval = null;
-        if( ds != null )
-        {
-            retval = PDActionFactory.createAction( ds );
-        }
-        return retval;
+        COSDictionary ds = actions.getCOSDictionary(COSName.DS);
+        return ds != null ? PDActionFactory.createAction(ds) : null;
     }
 
     /**
@@ -146,7 +132,7 @@ public class PDDocumentCatalogAdditional
      */
     public void setDS( PDAction ds )
     {
-        actions.setItem( "DS", ds );
+        actions.setItem(COSName.DS, ds);
     }
 
     /**
@@ -158,13 +144,8 @@ public class PDDocumentCatalogAdditional
      */
     public PDAction getWP()
     {
-        COSDictionary wp = (COSDictionary)actions.getDictionaryObject( "WP" );
-        PDAction retval = null;
-        if( wp != null )
-        {
-            retval = PDActionFactory.createAction( wp );
-        }
-        return retval;
+        COSDictionary wp = actions.getCOSDictionary(COSName.WP);
+        return wp != null ? PDActionFactory.createAction(wp) : null;
     }
 
     /**
@@ -176,7 +157,7 @@ public class PDDocumentCatalogAdditional
      */
     public void setWP( PDAction wp )
     {
-        actions.setItem( "WP", wp );
+        actions.setItem(COSName.WP, wp);
     }
 
     /**
@@ -188,13 +169,8 @@ public class PDDocumentCatalogAdditional
      */
     public PDAction getDP()
     {
-        COSDictionary dp = (COSDictionary)actions.getDictionaryObject( "DP" );
-        PDAction retval = null;
-        if( dp != null )
-        {
-            retval = PDActionFactory.createAction( dp );
-        }
-        return retval;
+        COSDictionary dp = actions.getCOSDictionary(COSName.DP);
+        return dp != null ? PDActionFactory.createAction(dp) : null;
     }
 
     /**
@@ -206,6 +182,6 @@ public class PDDocumentCatalogAdditional
      */
     public void setDP( PDAction dp )
     {
-        actions.setItem( "DP", dp );
+        actions.setItem(COSName.DP, dp);
     }
 }

Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/annotation/PDAnnotationFileAttachment.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/annotation/PDAnnotationFileAttachment.java?rev=1887633&r1=1887632&r2=1887633&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/annotation/PDAnnotationFileAttachment.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/annotation/PDAnnotationFileAttachment.java Sun Mar 14 14:50:02 2021
@@ -78,7 +78,7 @@ public class PDAnnotationFileAttachment
      */
     public PDFileSpecification getFile() throws IOException
     {
-        return PDFileSpecification.createFS(getCOSObject().getDictionaryObject("FS"));
+        return PDFileSpecification.createFS(getCOSObject().getDictionaryObject(COSName.FS));
     }
 
     /**
@@ -88,7 +88,7 @@ public class PDAnnotationFileAttachment
      */
     public void setFile(PDFileSpecification file)
     {
-        getCOSObject().setItem("FS", file);
+        getCOSObject().setItem(COSName.FS, file);
     }
 
     /**

Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/measurement/PDRectlinearMeasureDictionary.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/measurement/PDRectlinearMeasureDictionary.java?rev=1887633&r1=1887632&r2=1887633&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/measurement/PDRectlinearMeasureDictionary.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/measurement/PDRectlinearMeasureDictionary.java Sun Mar 14 14:50:02 2021
@@ -77,7 +77,7 @@ public class PDRectlinearMeasureDictiona
      */
     public PDNumberFormatDictionary[] getChangeXs()
     {
-        COSArray x = (COSArray)this.getCOSObject().getDictionaryObject("X");
+        COSArray x = getCOSObject().getCOSArray(COSName.X);
         if (x != null)
         {
             PDNumberFormatDictionary[] retval =
@@ -104,7 +104,7 @@ public class PDRectlinearMeasureDictiona
         {
             array.add(changeX);
         }
-        this.getCOSObject().setItem("X", array);
+        this.getCOSObject().setItem(COSName.X, array);
     }
 
     /**
@@ -114,7 +114,7 @@ public class PDRectlinearMeasureDictiona
      */
     public PDNumberFormatDictionary[] getChangeYs()
     {
-        COSArray y = (COSArray)this.getCOSObject().getDictionaryObject("Y");
+        COSArray y = getCOSObject().getCOSArray(COSName.Y);
         if (y != null)
         {
             PDNumberFormatDictionary[] retval =
@@ -141,7 +141,7 @@ public class PDRectlinearMeasureDictiona
         {
             array.add(changeY);
         }
-        this.getCOSObject().setItem("Y", array);
+        this.getCOSObject().setItem(COSName.Y, array);
     }
 
     /**
@@ -151,7 +151,7 @@ public class PDRectlinearMeasureDictiona
      */
     public PDNumberFormatDictionary[] getDistances()
     {
-        COSArray d = (COSArray)this.getCOSObject().getDictionaryObject("D");
+        COSArray d = getCOSObject().getCOSArray(COSName.D);
         if (d != null)
         {
             PDNumberFormatDictionary[] retval =
@@ -178,7 +178,7 @@ public class PDRectlinearMeasureDictiona
         {
             array.add(distance);
         }
-        this.getCOSObject().setItem("D", array);
+        this.getCOSObject().setItem(COSName.D, array);
     }
 
     /**
@@ -225,7 +225,7 @@ public class PDRectlinearMeasureDictiona
      */
     public PDNumberFormatDictionary[] getAngles()
     {
-        COSArray t = (COSArray)this.getCOSObject().getDictionaryObject("T");
+        COSArray t = getCOSObject().getCOSArray(COSName.T);
         if (t != null)
         {
             PDNumberFormatDictionary[] retval =
@@ -252,7 +252,7 @@ public class PDRectlinearMeasureDictiona
         {
             array.add(angle);
         }
-        this.getCOSObject().setItem("T", array);
+        this.getCOSObject().setItem(COSName.T, array);
     }
 
     /**
@@ -262,7 +262,7 @@ public class PDRectlinearMeasureDictiona
      */
     public PDNumberFormatDictionary[] getLineSloaps()
     {
-        COSArray s = (COSArray)this.getCOSObject().getDictionaryObject("S");
+        COSArray s = getCOSObject().getCOSArray(COSName.S);
         if (s != null)
         {
             PDNumberFormatDictionary[] retval =
@@ -289,7 +289,7 @@ public class PDRectlinearMeasureDictiona
         {
             array.add(lineSloap);
         }
-        this.getCOSObject().setItem("S", array);
+        this.getCOSObject().setItem(COSName.S, array);
     }
 
     /**
@@ -299,12 +299,8 @@ public class PDRectlinearMeasureDictiona
      */
     public float[] getCoordSystemOrigin()
     {
-        COSArray o = (COSArray)this.getCOSObject().getDictionaryObject("O");
-        if (o != null)
-        {
-            return o.toFloatArray();
-        }
-        return null;
+        COSArray o = getCOSObject().getCOSArray(COSName.O);
+        return o != null ? o.toFloatArray() : null;
     }
 
     /**
@@ -316,7 +312,7 @@ public class PDRectlinearMeasureDictiona
     {
         COSArray array = new COSArray();
         array.setFloatArray(coordSystemOrigin);
-        this.getCOSObject().setItem("O", array);
+        this.getCOSObject().setItem(COSName.O, array);
     }
 
     /**

Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/pagenavigation/PDThread.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/pagenavigation/PDThread.java?rev=1887633&r1=1887632&r2=1887633&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/pagenavigation/PDThread.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/pagenavigation/PDThread.java Sun Mar 14 14:50:02 2021
@@ -17,7 +17,7 @@
 package org.apache.pdfbox.pdmodel.interactive.pagenavigation;
 
 import org.apache.pdfbox.cos.COSDictionary;
-
+import org.apache.pdfbox.cos.COSName;
 import org.apache.pdfbox.pdmodel.PDDocumentInformation;
 import org.apache.pdfbox.pdmodel.common.COSObjectable;
 
@@ -49,7 +49,7 @@ public class PDThread implements COSObje
     public PDThread()
     {
         thread = new COSDictionary();
-        thread.setName( "Type", "Thread" );
+        thread.setItem(COSName.TYPE, COSName.THREAD);
     }
 
     /**
@@ -70,14 +70,8 @@ public class PDThread implements COSObje
      */
     public PDDocumentInformation getThreadInfo()
     {
-        PDDocumentInformation retval = null;
-        COSDictionary info = (COSDictionary)thread.getDictionaryObject( "I" );
-        if( info != null )
-        {
-            retval = new PDDocumentInformation( info );
-        }
-
-        return retval;
+        COSDictionary info = thread.getCOSDictionary(COSName.I);
+        return info != null ? new PDDocumentInformation(info) : null;
     }
 
     /**
@@ -87,7 +81,7 @@ public class PDThread implements COSObje
      */
     public void setThreadInfo( PDDocumentInformation info )
     {
-        thread.setItem( "I", info );
+        thread.setItem(COSName.I, info);
     }
 
     /**
@@ -98,14 +92,8 @@ public class PDThread implements COSObje
      */
     public PDThreadBead getFirstBead()
     {
-        PDThreadBead retval = null;
-        COSDictionary bead = (COSDictionary)thread.getDictionaryObject( "F" );
-        if( bead != null )
-        {
-            retval = new PDThreadBead( bead );
-        }
-
-        return retval;
+        COSDictionary bead = thread.getCOSDictionary(COSName.F);
+        return bead != null ? new PDThreadBead(bead) : null;
     }
 
     /**
@@ -120,7 +108,7 @@ public class PDThread implements COSObje
         {
             bead.setThread( this );
         }
-        thread.setItem( "F", bead );
+        thread.setItem(COSName.F, bead);
     }
 
 

Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/pagenavigation/PDThreadBead.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/pagenavigation/PDThreadBead.java?rev=1887633&r1=1887632&r2=1887633&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/pagenavigation/PDThreadBead.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/pagenavigation/PDThreadBead.java Sun Mar 14 14:50:02 2021
@@ -52,7 +52,7 @@ public class PDThreadBead implements COS
     public PDThreadBead()
     {
         bead = new COSDictionary();
-        bead.setName( "Type", "Bead" );
+        bead.setItem(COSName.TYPE, COSName.BEAD);
         setNextBead( this );
         setPreviousBead( this );
     }
@@ -76,13 +76,8 @@ public class PDThreadBead implements COS
      */
     public PDThread getThread()
     {
-        PDThread retval = null;
-        COSDictionary dic = (COSDictionary)bead.getDictionaryObject( "T" );
-        if( dic != null )
-        {
-            retval = new PDThread( dic );
-        }
-        return retval;
+        COSDictionary dic = bead.getCOSDictionary(COSName.T);
+        return dic != null ? new PDThread(dic) : null;
     }
 
     /**
@@ -93,7 +88,7 @@ public class PDThreadBead implements COS
      */
     public void setThread( PDThread thread )
     {
-        bead.setItem( "T", thread );
+        bead.setItem(COSName.T, thread);
     }
 
     /**
@@ -104,7 +99,7 @@ public class PDThreadBead implements COS
      */
     public PDThreadBead getNextBead()
     {
-        return new PDThreadBead( (COSDictionary) bead.getDictionaryObject( "N" ) );
+        return new PDThreadBead(bead.getCOSDictionary(COSName.N));
     }
 
     /**
@@ -114,7 +109,7 @@ public class PDThreadBead implements COS
      */
     protected final void setNextBead( PDThreadBead next )
     {
-        bead.setItem( "N", next );
+        bead.setItem(COSName.N, next);
     }
 
     /**
@@ -125,7 +120,7 @@ public class PDThreadBead implements COS
      */
     public PDThreadBead getPreviousBead()
     {
-        return new PDThreadBead( (COSDictionary) bead.getDictionaryObject( "V" ) );
+        return new PDThreadBead(bead.getCOSDictionary(COSName.V));
     }
 
     /**
@@ -135,7 +130,7 @@ public class PDThreadBead implements COS
      */
     protected final void setPreviousBead( PDThreadBead previous )
     {
-        bead.setItem( "V", previous );
+        bead.setItem(COSName.V, previous);
     }
 
     /**
@@ -160,13 +155,8 @@ public class PDThreadBead implements COS
      */
     public PDPage getPage()
     {
-        PDPage page = null;
-        COSDictionary dic = (COSDictionary)bead.getDictionaryObject( "P" );
-        if( dic != null )
-        {
-            page = new PDPage( dic );
-        }
-        return page;
+        COSDictionary dic = bead.getCOSDictionary(COSName.P);
+        return dic != null ? new PDPage(dic) : null;
     }
 
     /**
@@ -178,7 +168,7 @@ public class PDThreadBead implements COS
      */
     public void setPage( PDPage page )
     {
-        bead.setItem( "P", page );
+        bead.setItem(COSName.P, page);
     }
 
     /**
@@ -188,13 +178,8 @@ public class PDThreadBead implements COS
      */
     public PDRectangle getRectangle()
     {
-        PDRectangle rect = null;
-        COSArray array = (COSArray)bead.getDictionaryObject( COSName.R );
-        if( array != null )
-        {
-            rect = new PDRectangle( array );
-        }
-        return rect;
+        COSArray array = bead.getCOSArray(COSName.R);
+        return array != null ? new PDRectangle(array) : null;
     }
 
     /**