Top Description Inners Fields Constructors Methods
de.rototor.pdfbox.graphics2d

public Class PdfBoxGraphics2DLosslessImageEncoder

extends Object
implements IPdfBoxGraphics2DImageEncoder
Class Inheritance
All Implemented Interfaces
de.rototor.pdfbox.graphics2d.IPdfBoxGraphics2DImageEncoder
Imports
org.apache.pdfbox.pdmodel.PDDocument, .PDPageContentStream, org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace, .PDICCBased, org.apache.pdfbox.pdmodel.graphics.image.LosslessFactory, .PDImageXObject, java.awt.*, java.awt.color.ColorSpace, .ICC_ColorSpace, .ICC_Profile, java.awt.image.BufferedImage, java.io.IOException, java.lang.ref.SoftReference, java.util.HashMap, .Map

Encodes all images using lossless compression. Tries to reuse images as much as possible. You can share an instance of this class with multiple PdfBoxGraphics2D objects.

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
private static class

Field Summary

Modifier and TypeField and Description
private SoftReference<PDDocument>
private Map<PdfBoxGraphics2DLosslessImageEncoder.ImageSoftReference, SoftReference<PDImageXObject>>
private Map<PdfBoxGraphics2DLosslessImageEncoder.ProfileSoftReference, SoftReference<PDColorSpace>>

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public PDImageXObject
encodeImage(PDDocument
the PDF document
document
,
PDPageContentStream
the content stream of the page
contentStream
,
Image
the image to encode
image
,
IPdfBoxGraphics2DImageEncoder.IPdfBoxGraphics2DImageEncoderEnv env)

Implements de.rototor.pdfbox.graphics2d.IPdfBoxGraphics2DImageEncoder.encodeImage.

Encode the given image into the a PDImageXObject

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

docback to summary
private SoftReference<PDDocument> doc
imageMapback to summary
private Map<PdfBoxGraphics2DLosslessImageEncoder.ImageSoftReference, SoftReference<PDImageXObject>> imageMap
profileMapback to summary
private Map<PdfBoxGraphics2DLosslessImageEncoder.ProfileSoftReference, SoftReference<PDColorSpace>> profileMap

Constructor Detail

PdfBoxGraphics2DLosslessImageEncoderback to summary
public PdfBoxGraphics2DLosslessImageEncoder()

Method Detail

encodeImageback to summary
public PDImageXObject encodeImage(PDDocument document, PDPageContentStream contentStream, Image image, IPdfBoxGraphics2DImageEncoder.IPdfBoxGraphics2DImageEncoderEnv env)

Implements de.rototor.pdfbox.graphics2d.IPdfBoxGraphics2DImageEncoder.encodeImage.

Doc from de.rototor.pdfbox.graphics2d.IPdfBoxGraphics2DImageEncoder.encodeImage.

Encode the given image into the a PDImageXObject

Parameters
document:PDDocument

the PDF document

contentStream:PDPageContentStream

the content stream of the page

image:Image

the image to encode

Returns:PDImageXObject

the encoded image

Annotations
@Override
de.rototor.pdfbox.graphics2d back to summary

private Class PdfBoxGraphics2DLosslessImageEncoder.ImageSoftReference

extends SoftReference<Image>
Class Inheritance

Field Summary

Modifier and TypeField and Description
private final IPdfBoxGraphics2DImageEncoder.IPdfBoxGraphics2DImageEncoderEnv.ImageInterpolation

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
obj
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

Inherited from java.lang.ref.SoftReference:
get

Field Detail

interpolationback to summary
private final IPdfBoxGraphics2DImageEncoder.IPdfBoxGraphics2DImageEncoderEnv.ImageInterpolation interpolation

Constructor Detail

ImageSoftReferenceback to summary
pack-priv ImageSoftReference(Image referent, IPdfBoxGraphics2DImageEncoder.IPdfBoxGraphics2DImageEncoderEnv.ImageInterpolation interpolation)

Method Detail

equalsback to summary
public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
de.rototor.pdfbox.graphics2d back to summary

private Class PdfBoxGraphics2DLosslessImageEncoder.ProfileSoftReference

extends SoftReference<ICC_Profile>
Class Inheritance

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
obj
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

Inherited from java.lang.ref.SoftReference:
get

Constructor Detail

ProfileSoftReferenceback to summary
pack-priv ProfileSoftReference(ICC_Profile referent)

Method Detail

equalsback to summary
public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override