svn commit: r1769017 - /pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/pattern/PDAbstractPattern.java

[ti...@apache.org]

Author: tilman
Date: Wed Nov  9 22:03:42 2016
New Revision: 1769017

URL: http://svn.apache.org/viewvc?rev=1769017&view=rev
Log:
PDFBOX-2852: clarify misleading javadoc

Modified:
    pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/pattern/PDAbstractPattern.java

Modified: pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/pattern/PDAbstractPattern.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/pattern/PDAbstractPattern.java?rev=1769017&r1=1769016&r2=1769017&view=diff
==============================================================================
--- pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/pattern/PDAbstractPattern.java (original)
+++ pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/pattern/PDAbstractPattern.java Wed Nov  9 22:03:42 2016
@@ -27,7 +27,7 @@ import org.apache.pdfbox.pdmodel.common.
 import org.apache.pdfbox.util.Matrix;
 
 /**
- * A Pattern dictionary from a page's resources.
+ * This class wraps a pattern dictionary. Patterns can be found in resource dictionaries.
  */
 public abstract class PDAbstractPattern implements COSObjectable
 {
@@ -39,21 +39,21 @@ public abstract class PDAbstractPattern
 
     /**
      * Create the correct PD Model pattern based on the COS base pattern.
-     * @param resourceDictionary the COS pattern dictionary
-     * @return the newly created pattern resources object
+     * @param dictionary the COS pattern dictionary
+     * @return the newly created pattern object
      * @throws IOException If we are unable to create the PDPattern object.
      */
-    public static PDAbstractPattern create(COSDictionary resourceDictionary) throws IOException
+    public static PDAbstractPattern create(COSDictionary dictionary) throws IOException
     {
         PDAbstractPattern pattern;
-        int patternType = resourceDictionary.getInt(COSName.PATTERN_TYPE, 0);
+        int patternType = dictionary.getInt(COSName.PATTERN_TYPE, 0);
         switch (patternType)
         {
             case TYPE_TILING_PATTERN:
-                pattern = new PDTilingPattern(resourceDictionary);
+                pattern = new PDTilingPattern(dictionary);
                 break;
             case TYPE_SHADING_PATTERN:
-                pattern = new PDShadingPattern(resourceDictionary);
+                pattern = new PDShadingPattern(dictionary);
                 break;
             default:
                 throw new IOException("Error: Unknown pattern type " + patternType);
@@ -74,16 +74,16 @@ public abstract class PDAbstractPattern
 
     /**
      * Creates a new Pattern dictionary from the given COS dictionary.
-     * @param resourceDictionary The COSDictionary for this pattern resource.
+     * @param dictionary The COSDictionary for this pattern.
      */
-    public PDAbstractPattern(COSDictionary resourceDictionary)
+    public PDAbstractPattern(COSDictionary dictionary)
     {
-        patternDictionary = resourceDictionary;
+        patternDictionary = dictionary;
     }
 
     /**
      * This will get the underlying dictionary.
-     * @return The dictionary for these pattern resources.
+     * @return The dictionary for this pattern.
      */
     @Override
     public COSDictionary getCOSObject()