DeflatedChunksSet (PNGJ 2.0.1 API)

java.lang.Object
- ar.com.hjg.pngj.DeflatedChunksSet

Direct Known Subclasses:

IdatSet
```
public class DeflatedChunksSet
extends Object
```
A set of IDAT-like chunks which, concatenated, form a zlib stream.
The inflated stream is intented to be read as a sequence of "rows", of which the caller knows the lengths (not necessary equal) and number.
Eg: For IDAT non-interlaced images, a row has bytesPerRow + 1 filter byte
For interlaced images, the lengths are variable.
This class can work in sync (polled) mode or async (callback) mode
See IdatSet, which is mostly used and has a slightly simpler use.
See DeflatedChunkSetTest for example of use.

Field Summary

Fields
Modifier and Type Field and Description

String chunkid
All IDAT-like chunks that form a same DeflatedChunksSet should have the same id

protected byte[] row

Fields
Modifier and Type	Field and Description
`String`	`chunkid` All IDAT-like chunks that form a same DeflatedChunksSet should have the same id
`protected byte[]`	`row`

Constructor Summary

Constructors
Constructor and Description
`DeflatedChunksSet(String chunkid, int initialRowLen, int maxRowLen)`
`DeflatedChunksSet(String chunkid, int initialRowLen, int maxRowLen, Inflater inflater, byte[] buffer)`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`allowOtherChunksInBetween(String id)` Some IDAT-like set can allow other chunks in between (APGN?).
`protected void`	`appendNewChunk(DeflatedChunkReader cr)`
`void`	`end()` this should be called only when discarding this object, or for aborting
`byte[]`	`getInflatedRow()` Inflated buffer.
`int`	`getnFedBytes()` total number of bytes that have been fed to this object
`int`	`getRowFilled()` This the amount of valid bytes in the buffer
`int`	`getRowLen()` Target size of the current row, including filter byte.
`int`	`getRown()` Get current (last) row number.
`boolean`	`isCallbackMode()` Callback mode = async processing
`boolean`	`isDone()` In this state, all relevant data has been uncompressed and retrieved.
`boolean`	`isRowReady()` In this state, the object is waiting the caller to retrieve inflated data
`boolean`	`isWaitingForMoreInput()` In this state, the object is waiting for more input to deflate.
`protected void`	`prepareForNextRow(int len)` Should be called after the previous row was processed
`protected void`	`preProcessRow()` Called automatically in all modes when a full row has been inflated.
`protected void`	`processBytes(byte[] buf, int off, int len)` Feeds the inflater with the compressed bytes In poll mode, the caller should not call repeatedly this, without consuming first, checking isDataReadyForConsumer()
`protected int`	`processRowCallback()` callback, must be implemented in callbackMode Must return byes of next row, for next callback
`void`	`setCallbackMode(boolean callbackMode)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - row
```
protected byte[] row
```
  - chunkid
```
public final String chunkid
```
    All IDAT-like chunks that form a same DeflatedChunksSet should have the same id
- Constructor Detail
  - DeflatedChunksSet
```
public DeflatedChunksSet(String chunkid,
                 int initialRowLen,
                 int maxRowLen,
                 Inflater inflater,
                 byte[] buffer)
```
    Parameters:
    initialRowLen - Length in bytes of first "row" (see description)
    maxRowLen - Max length in bytes of "rows"
    inflater - Can be null. If not null, will be reset
  - DeflatedChunksSet
```
public DeflatedChunksSet(String chunkid,
                 int initialRowLen,
                 int maxRowLen)
```
- Method Detail
  - appendNewChunk
```
protected void appendNewChunk(DeflatedChunkReader cr)
```
  - processBytes
```
protected void processBytes(byte[] buf,
                int off,
                int len)
```
    Feeds the inflater with the compressed bytes In poll mode, the caller should not call repeatedly this, without consuming first, checking isDataReadyForConsumer()
    
    Parameters:
    buf -
    off -
    len -
  - preProcessRow
```
protected void preProcessRow()
```
    Called automatically in all modes when a full row has been inflated.
  - processRowCallback
```
protected int processRowCallback()
```
    callback, must be implemented in callbackMode Must return byes of next row, for next callback
  - getInflatedRow
```
public byte[] getInflatedRow()
```
    Inflated buffer. The effective length is given by getRowFilled()
  - prepareForNextRow
```
protected void prepareForNextRow(int len)
```
    Should be called after the previous row was processed
    Pass 0 or negative to signal that we are done (not expecting more bytes)
    This resets rowfilled
  - isWaitingForMoreInput
```
public boolean isWaitingForMoreInput()
```
    In this state, the object is waiting for more input to deflate.
    Only in this state it's legal to feed this
  - isRowReady
```
public boolean isRowReady()
```
    In this state, the object is waiting the caller to retrieve inflated data
    Effective length: see getRowFilled()
  - isDone
```
public boolean isDone()
```
    In this state, all relevant data has been uncompressed and retrieved.
    We can still feed this object, but the bytes will be swallowed/ignored.
  - end
```
public void end()
```
    this should be called only when discarding this object, or for aborting
  - getRowLen
```
public int getRowLen()
```
    Target size of the current row, including filter byte.
    should coincide (or be less than) with row.length
  - getRowFilled
```
public int getRowFilled()
```
    This the amount of valid bytes in the buffer
  - getRown
```
public int getRown()
```
    Get current (last) row number.
    This corresponds to the raw numeration of rows as seen by the deflater. Not the same as the real image row, if interlaced.
  - allowOtherChunksInBetween
```
public boolean allowOtherChunksInBetween(String id)
```
    Some IDAT-like set can allow other chunks in between (APGN?).
    Normally false.
    
    Parameters:
    id - Id of the other chunk that appeared in middel of this set.
    
    Returns:
    true if allowed
  - isCallbackMode
```
public boolean isCallbackMode()
```
    Callback mode = async processing
  - setCallbackMode
```
public void setCallbackMode(boolean callbackMode)
```
  - getnFedBytes
```
public int getnFedBytes()
```
    total number of bytes that have been fed to this object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class DeflatedChunksSet

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

row

chunkid

Constructor Detail

DeflatedChunksSet

DeflatedChunksSet

Method Detail

appendNewChunk

processBytes

preProcessRow

processRowCallback

getInflatedRow

prepareForNextRow

isWaitingForMoreInput

isRowReady

isDone

end

getRowLen

getRowFilled

getRown

allowOtherChunksInBetween

isCallbackMode

setCallbackMode

getnFedBytes

toString