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 2018/08/28 03:39:46 UTC
svn commit: r1839393 -
/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/image/JPEGFactory.java
Author: tilman
Date: Tue Aug 28 03:39:46 2018
New Revision: 1839393
URL: http://svn.apache.org/viewvc?rev=1839393&view=rev
Log:
PDFBOX-4071: improve javadoc
Modified:
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/image/JPEGFactory.java
Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/image/JPEGFactory.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/image/JPEGFactory.java?rev=1839393&r1=1839392&r2=1839393&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/image/JPEGFactory.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/image/JPEGFactory.java Tue Aug 28 03:39:46 2018
@@ -33,6 +33,7 @@ import javax.imageio.IIOImage;
import javax.imageio.ImageIO;
import javax.imageio.ImageReader;
import javax.imageio.ImageTypeSpecifier;
+import javax.imageio.ImageWriteParam;
import javax.imageio.ImageWriter;
import javax.imageio.metadata.IIOMetadata;
import javax.imageio.plugins.jpeg.JPEGImageWriteParam;
@@ -194,7 +195,9 @@ public final class JPEGFactory
* The image will be created with a dpi value of 72 to be stored in metadata.
* @param document the document where the image will be created
* @param image the BufferedImage to embed
- * @param quality the desired JPEG compression quality
+ * @param quality The desired JPEG compression quality; between 0 (best
+ * compression) and 1 (best image quality). See
+ * {@link ImageWriteParam#setCompressionQuality(float)} for more details.
* @return a new Image XObject
* @throws IOException if the JPEG data cannot be written
*/
@@ -213,7 +216,9 @@ public final class JPEGFactory
*
* @param document the document where the image will be created
* @param image the BufferedImage to embed
- * @param quality the desired JPEG compression quality
+ * @param quality The desired JPEG compression quality; between 0 (best
+ * compression) and 1 (best image quality). See
+ * {@link ImageWriteParam#setCompressionQuality(float)} for more details.
* @param dpi the desired dpi (resolution) value of the JPEG to be stored in metadata. This
* value has no influence on image content or size.
* @return a new Image XObject