You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pdfbox.apache.org by ti...@apache.org on 2016/11/08 21:22:27 UTC
svn commit: r1768783 -
/pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/image/PDImageXObject.java
Author: tilman
Date: Tue Nov 8 21:22:27 2016
New Revision: 1768783
URL: http://svn.apache.org/viewvc?rev=1768783&view=rev
Log:
PDFBOX-2852: improve javadoc
Modified:
pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/image/PDImageXObject.java
Modified: pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/image/PDImageXObject.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/image/PDImageXObject.java?rev=1768783&r1=1768782&r2=1768783&view=diff
==============================================================================
--- pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/image/PDImageXObject.java (original)
+++ pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/image/PDImageXObject.java Tue Nov 8 21:22:27 2016
@@ -63,7 +63,11 @@ public final class PDImageXObject extend
private SoftReference<BufferedImage> cachedImage;
private PDColorSpace colorSpace;
- private final PDResources resources; // current resource dictionary (has color spaces)
+
+ /**
+ * current resource dictionary (has color spaces)
+ */
+ private final PDResources resources;
/**
* Creates a thumbnail Image XObject from the given COSBase and name.
@@ -79,7 +83,10 @@ public final class PDImageXObject extend
}
/**
- * Creates an Image XObject in the given document.
+ * Creates an Image XObject in the given document. This constructor is for internal PDFBox use
+ * and is not for PDF generation. Users who want to create images should look at {@link #createFromFileByExtension(File, PDDocument)
+ * }.
+ *
* @param document the current document
* @throws java.io.IOException if there is an error creating the XObject.
*/
@@ -89,7 +96,10 @@ public final class PDImageXObject extend
}
/**
- * Creates an Image XObject in the given document using the given filtered stream.
+ * Creates an Image XObject in the given document using the given filtered stream. This
+ * constructor is for internal PDFBox use and is not for PDF generation. Users who want to
+ * create images should look at {@link #createFromFileByExtension(File, PDDocument) }.
+ *
* @param document the current document
* @param encodedStream an encoded stream of image data
* @param cosFilter the filter or a COSArray of filters
@@ -137,7 +147,10 @@ public final class PDImageXObject extend
}
/**
- * Creates an Image XObject with the given stream as its contents and current color spaces.
+ * Creates an Image XObject with the given stream as its contents and current color spaces. This
+ * constructor is for internal PDFBox use and is not for PDF generation. Users who want to
+ * create images should look at {@link #createFromFileByExtension(File, PDDocument) }.
+ *
* @param stream the XObject stream to read
* @param resources the current resources
* @throws java.io.IOException if there is an error creating the XObject.