org.apache.xmlgraphics.image.loader.impl

## Class JPEGFile

- java.lang.Object
- - org.apache.xmlgraphics.image.loader.impl.JPEGFile

- All Implemented Interfaces:
    JPEGConstants

      public class JPEGFile
      extends java.lang.Object
      implements JPEGConstants

  Provides methods useful for processing JPEG files.

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `protected static org.apache.commons.logging.Log` | `log` logger

    - ### Fields inherited from interface org.apache.xmlgraphics.image.loader.impl.JPEGConstants

      `APP0, APP1, APP2, APPD, APPE, APPF, EOI, MARK, NULL, SOF0, SOF1, SOF2, SOFA, SOI, SOS`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `JPEGFile(javax.imageio.stream.ImageInputStream in)` Constructor for ImageInputStreams.
    `JPEGFile(java.io.InputStream in)` Constructor for InputStreams.

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `java.io.DataInput` | `getDataInput()` Returns the `DataInput` instance this object operates on.
    `int` | `readMarkerSegment()` Reads the next marker segment identifier and returns it.
    `int` | `readSegmentLength()` Reads the segment length of the current marker segment and returns it.
    `void` | `skipCurrentMarkerSegment()` Skips the current marker segment.

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Field Detail

    - #### log

          protected static final org.apache.commons.logging.Log log

      logger

  - ### Constructor Detail

    - #### JPEGFile

          public JPEGFile(javax.imageio.stream.ImageInputStream in)

      Constructor for ImageInputStreams.
      Parameters:
        `in` - the input stream to read the image from

    - #### JPEGFile

          public JPEGFile(java.io.InputStream in)

      Constructor for InputStreams.
      Parameters:
        `in` - the input stream to read the image from

  - ### Method Detail

    - #### getDataInput

          public java.io.DataInput getDataInput()

      Returns the `DataInput` instance this object operates on.
      Returns:
        the data input instance

    - #### readMarkerSegment

          public int readMarkerSegment()
                                throws java.io.IOException

      Reads the next marker segment identifier and returns it.
      Returns:
        the marker segment identifier
      Throws:
        `java.io.IOException` - if an I/O error occurs while reading from the image file

    - #### readSegmentLength

          public int readSegmentLength()
                                throws java.io.IOException

      Reads the segment length of the current marker segment and returns it. The method assumes the file cursor is right after the segment header.
      Returns:
        the segment length
      Throws:
        `java.io.IOException` - if an I/O error occurs while reading from the image file

    - #### skipCurrentMarkerSegment

          public void skipCurrentMarkerSegment()
                                        throws java.io.IOException

      Skips the current marker segment. The method assumes the file cursor is right after the segment header.
      Throws:
        `java.io.IOException` - if an I/O error occurs while reading from the image file

Copyright 1999-2024 The Apache Software Foundation. All Rights Reserved.