Top Description Fields Constructors Methods
jogamp.opengl.util.pngj.chunks

public Class ChunksList

extends Object
Class Inheritance
Known Direct Subclasses
jogamp.opengl.util.pngj.chunks.ChunksListForWrite
Imports
java.util.ArrayList, .HashMap, .List, jogamp.opengl.util.pngj.ImageInfo, .PngjException
All chunks that form an image, read or to be written.

chunks include all chunks, but IDAT is a single pseudo chunk without data

Field Summary

Modifier and TypeField and Description
public static final int
CHUNK_GROUP_0_IDHR

public static final int
CHUNK_GROUP_1_AFTERIDHR

public static final int
CHUNK_GROUP_2_PLTE

public static final int
CHUNK_GROUP_3_AFTERPLTE

public static final int
CHUNK_GROUP_4_IDAT

public static final int
CHUNK_GROUP_5_AFTERIDAT

public static final int
CHUNK_GROUP_6_END

protected List<PngChunk>
chunks

All chunks, read (or written) But IDAT is a single pseudo chunk without data

pack-priv final ImageInfo
imageInfo

Constructor Summary

AccessConstructor and Description
public
ChunksList(final ImageInfo imfinfo)

Method Summary

Modifier and TypeMethod and Description
public void
appendReadChunk(final PngChunk chunk, final int chunkGroup)

Adds chunk in next position.

public List<? extends PngChunk>

Returns:

List, empty if none
getById(final String id)

All chunks with this ID

public List<? extends PngChunk>

Returns:

innerid Only used for text and SPLT chunks
getById(final String id, final String innerid)

If innerid!=null and the chunk is PngChunkTextVar or PngChunkSPLT, it's filtered by that id

public PngChunk

Returns:

First chunk found, null if not found
getById1(final String id)

Returns only one chunk

public PngChunk
getById1(final String id, final boolean failIfMultiple)

Returns only one chunk or null if nothing found - does not include queued

If more than one chunk is found, then an exception is thrown (failifMultiple=true or chunk is single) or the last one is returned (failifMultiple=false)

public PngChunk
getById1(final String id, final String innerid, final boolean failIfMultiple)

Returns only one chunk or null if nothing found - does not include queued

If more than one chunk (after filtering by inner id) is found, then an exception is thrown (failifMultiple=true or chunk is single) or the last one is returned (failifMultiple=false)

public ArrayList<PngChunk>
getChunks()

Returns a copy of the list (but the chunks are not copied) This should not be used for general metadata handling

public HashMap<String, Integer>

Returns:

key:chunk id, val: number of occurrences
getChunksKeys()

Keys of processed (read or writen) chunks

public List<PngChunk>

Returns:

Empty if nothing found
getEquivalent(final PngChunk c2)

Finds all chunks "equivalent" to this one

protected static List<PngChunk>
getXById(final List<PngChunk> list, final String id, final String innerid)

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
public String
toStringFull()

for debugging

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

CHUNK_GROUP_0_IDHRback to summary
public static final int CHUNK_GROUP_0_IDHR
CHUNK_GROUP_1_AFTERIDHRback to summary
public static final int CHUNK_GROUP_1_AFTERIDHR
CHUNK_GROUP_2_PLTEback to summary
public static final int CHUNK_GROUP_2_PLTE
CHUNK_GROUP_3_AFTERPLTEback to summary
public static final int CHUNK_GROUP_3_AFTERPLTE
CHUNK_GROUP_4_IDATback to summary
public static final int CHUNK_GROUP_4_IDAT
CHUNK_GROUP_5_AFTERIDATback to summary
public static final int CHUNK_GROUP_5_AFTERIDAT
CHUNK_GROUP_6_ENDback to summary
public static final int CHUNK_GROUP_6_END
chunksback to summary
protected List<PngChunk> chunks

All chunks, read (or written) But IDAT is a single pseudo chunk without data

imageInfoback to summary
pack-priv final ImageInfo imageInfo

Constructor Detail

ChunksListback to summary
public ChunksList(final ImageInfo imfinfo)

Method Detail

appendReadChunkback to summary
public void appendReadChunk(final PngChunk chunk, final int chunkGroup)

Adds chunk in next position. This is used onyl by the pngReader

getByIdback to summary
public List<? extends PngChunk> getById(final String id)

All chunks with this ID

Returns:List<? extends PngChunk>

List, empty if none

getByIdback to summary
public List<? extends PngChunk> getById(final String id, final String innerid)

If innerid!=null and the chunk is PngChunkTextVar or PngChunkSPLT, it's filtered by that id

Returns:List<? extends PngChunk>

  • innerid Only used for text and SPLT chunks
  • List, empty if none
getById1back to summary
public PngChunk getById1(final String id)

Returns only one chunk

Returns:PngChunk

First chunk found, null if not found

getById1back to summary
public PngChunk getById1(final String id, final boolean failIfMultiple)

Returns only one chunk or null if nothing found - does not include queued

If more than one chunk is found, then an exception is thrown (failifMultiple=true or chunk is single) or the last one is returned (failifMultiple=false)

getById1back to summary
public PngChunk getById1(final String id, final String innerid, final boolean failIfMultiple)

Returns only one chunk or null if nothing found - does not include queued

If more than one chunk (after filtering by inner id) is found, then an exception is thrown (failifMultiple=true or chunk is single) or the last one is returned (failifMultiple=false)

getChunksback to summary
public ArrayList<PngChunk> getChunks()

Returns a copy of the list (but the chunks are not copied) This should not be used for general metadata handling

getChunksKeysback to summary
public HashMap<String, Integer> getChunksKeys()

Keys of processed (read or writen) chunks

Returns:HashMap<String, Integer>

key:chunk id, val: number of occurrences

getEquivalentback to summary
public List<PngChunk> getEquivalent(final PngChunk c2)

Finds all chunks "equivalent" to this one

Returns:List<PngChunk>

Empty if nothing found

getXByIdback to summary
protected static List<PngChunk> getXById(final List<PngChunk> list, final String id, final String innerid)
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object

Annotations
@Override
toStringFullback to summary
public String toStringFull()

for debugging