Class ImageInfo


  • public class ImageInfo
    extends java.lang.Object
    ImageInfo represents a collection of basic properties of an image, such as width, height, format, bit depth, etc.
    • Constructor Detail

      • ImageInfo

        public ImageInfo​(java.lang.String formatDetails,
                         int bitsPerPixel,
                         java.util.List<java.lang.String> comments,
                         ImageFormat format,
                         java.lang.String formatName,
                         int height,
                         java.lang.String mimeType,
                         int numberOfImages,
                         int physicalHeightDpi,
                         float physicalHeightInch,
                         int physicalWidthDpi,
                         float physicalWidthInch,
                         int width,
                         boolean progressive,
                         boolean transparent,
                         boolean usesPalette,
                         ImageInfo.ColorType colorType,
                         ImageInfo.CompressionAlgorithm compressionAlgorithm)
    • Method Detail

      • getBitsPerPixel

        public int getBitsPerPixel()
        Returns the bits per pixel of the image data.
      • getComments

        public java.util.List<java.lang.String> getComments()
        Returns a list of comments from the image file.

        This is mostly obsolete.

      • getFormat

        public ImageFormat getFormat()
        Returns the image file format, ie. ImageFormat.IMAGE_FORMAT_PNG.

        Returns ImageFormat.IMAGE_FORMAT_UNKNOWN if format is unknown.

        Returns:
        A constant defined in ImageFormat.
        See Also:
        ImageFormats
      • getFormatName

        public java.lang.String getFormatName()
        Returns a string with the name of the image file format.
        See Also:
        getFormat()
      • getHeight

        public int getHeight()
        Returns the height of the image in pixels.
        See Also:
        getWidth()
      • getMimeType

        public java.lang.String getMimeType()
        Returns the MIME type of the image.
        See Also:
        getFormat()
      • getNumberOfImages

        public int getNumberOfImages()
        Returns the number of images in the file.

        Applies mostly to GIF and TIFF; reading PSD/Photoshop layers is not supported, and Jpeg/JFIF EXIF thumbnails are not included in this count.

      • getPhysicalHeightDpi

        public int getPhysicalHeightDpi()
        Returns horizontal dpi of the image, if available.

        Applies to TIFF (optional), BMP (always), GIF (constant: 72), Jpeg (optional), PNG (optional), PNM (constant: 72), PSD/Photoshop (constant: 72).

        Returns:
        returns -1 if not present.
      • getPhysicalHeightInch

        public float getPhysicalHeightInch()
        Returns physical height of the image in inches, if available.

        Applies to TIFF (optional), BMP (always), GIF (constant: 72), Jpeg (optional), PNG (optional), PNM (constant: 72), PSD/Photoshop (constant: 72).

        Returns:
        returns -1 if not present.
      • getPhysicalWidthDpi

        public int getPhysicalWidthDpi()
        Returns vertical dpi of the image, if available.

        Applies to TIFF (optional), BMP (always), GIF (constant: 72), Jpeg (optional), PNG (optional), PNM (constant: 72), PSD/Photoshop (constant: 72).

        Returns:
        returns -1 if not present.
      • getPhysicalWidthInch

        public float getPhysicalWidthInch()
        Returns physical width of the image in inches, if available.

        Applies to TIFF (optional), BMP (always), GIF (constant: 72), Jpeg (optional), PNG (optional), PNM (constant: 72), PSD/Photoshop (constant: 72).

        Returns:
        returns -1 if not present.
      • getWidth

        public int getWidth()
        Returns the width of the image in pixels.
        See Also:
        getHeight()
      • isProgressive

        public boolean isProgressive()
        Returns true if the image is progressive or interlaced.
      • dump

        public void dump()
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • toString

        public void toString​(java.io.PrintWriter pw,
                             java.lang.String prefix)
      • getFormatDetails

        public java.lang.String getFormatDetails()
        Returns a description of the file format, ie. format version.
      • isTransparent

        public boolean isTransparent()
        Returns true if the image has transparency.
      • usesPalette

        public boolean usesPalette()
        Returns true if the image uses a palette.
      • getCompressionAlgorithm

        public ImageInfo.CompressionAlgorithm getCompressionAlgorithm()
        Returns a description of the compression algorithm, if any.