Module io.scif

Package io.scif.formats

Class APNGFormat.Metadata

java.lang.Object

org.scijava.AbstractContextual

org.scijava.plugin.AbstractRichPlugin

io.scif.AbstractSCIFIOPlugin

io.scif.AbstractHasFormat

io.scif.AbstractHasSource

io.scif.AbstractMetadata

io.scif.formats.APNGFormat.Metadata

All Implemented Interfaces:

HasFormat, HasMetaTable, HasSource, Metadata, SCIFIOPlugin, TypedMetadata, Serializable, Comparable<org.scijava.Prioritized>, org.scijava.Contextual, org.scijava.Identifiable, org.scijava.Locatable, org.scijava.log.Logged, org.scijava.plugin.HasPluginInfo, org.scijava.plugin.RichPlugin, org.scijava.plugin.SciJavaPlugin, org.scijava.Prioritized, org.scijava.Versioned

Enclosing class:

APNGFormat

public static class APNGFormat.Metadata
extends AbstractMetadata

File format SCIFIO Metadata for Animated Portable Network Graphics (APNG) images.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_KEY

Constructor Summary

Constructors

Constructor	Description
Metadata()

Method Summary

Modifier and Type	Method	Description
void	addIdat(APNGFormat.IDATChunk idat)
void	close(boolean fileOnly)	Closes the image source(s) associated with this component, with a toggle to determine if the component itself is reset.
APNGFormat.ACTLChunk	getActl()
List<APNGFormat.FCTLChunk>	getFctl()
List<APNGFormat.IDATChunk>	getIdat()
APNGFormat.IENDChunk	getIend()
APNGFormat.IHDRChunk	getIhdr()
APNGFormat.PLTEChunk	getPlte()
boolean	isLittleEndian()
boolean	isSeparateDefault()
boolean	isSigned()
void	populateImageMetadata()	Generates format-agnostic image metadata structures based on this instance's format-specific metadata.
void	setActl(APNGFormat.ACTLChunk actl)
void	setFctl(List<APNGFormat.FCTLChunk> fctl)
void	setIdat(List<APNGFormat.IDATChunk> idat)
void	setIend(APNGFormat.IENDChunk iend)
void	setIhdr(APNGFormat.IHDRChunk ihdr)
void	setLittleEndian(boolean littleEndian)	Sets the littleEndian flag on this metadata.
void	setPlte(APNGFormat.PLTEChunk plte)
void	setSeparateDefault(boolean separateDefault)	Sets whether or not the first (default) frame is part of the animation or not.
void	setSigned(boolean signed)	Sets whether this dataset's pixel type is signed or not.

Methods inherited from class io.scif.AbstractMetadata

add, createImageMetadata, get, getAll, getDatasetName, getDatasetSize, getDestinationLocation, getImageCount, getSource, getSourceLocation, getTable, isFiltered, setDatasetName, setDestinationLocation, setFiltered, setSource, setSourceLocation, setTable

Methods inherited from class io.scif.AbstractHasSource

close

Methods inherited from class io.scif.AbstractHasFormat

asBrowsableLocation, asBrowsableLocation, getFormat, getFormatName

Methods inherited from class io.scif.AbstractSCIFIOPlugin

getVersion, log

Methods inherited from class org.scijava.plugin.AbstractRichPlugin

getInfo, getPriority, setInfo, setPriority, toString

Methods inherited from class org.scijava.AbstractContextual

context, getContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.scijava.Contextual

context, getContext, setContext

Methods inherited from interface io.scif.HasFormat

getFormat, getFormatName

Methods inherited from interface org.scijava.plugin.HasPluginInfo

getInfo, setInfo

Methods inherited from interface io.scif.HasSource

close

Methods inherited from interface org.scijava.Locatable

getLocation

Methods inherited from interface org.scijava.Prioritized

compareTo, getPriority, setPriority

Methods inherited from interface org.scijava.plugin.RichPlugin

getIdentifier

Methods inherited from interface io.scif.SCIFIOPlugin

getVersion, log

Field Detail

DEFAULT_KEY

public static final String DEFAULT_KEY

See Also:

Constant Field Values

Constructor Detail

Metadata

public Metadata()

Method Detail

isSigned

public boolean isSigned()

Returns:

true iff this dataset's pixel type is signed

setSigned

public void setSigned(boolean signed)

Sets whether this dataset's pixel type is signed or not.

isSeparateDefault

public boolean isSeparateDefault()

Returns:

true iff the first frame is not part of the animation.

setSeparateDefault

public void setSeparateDefault(boolean separateDefault)

Sets whether or not the first (default) frame is part of the animation or not.

isLittleEndian

public boolean isLittleEndian()

Returns:

true iff this dataset is littleEndian. APNG is typically big endian by default/by spec.

setLittleEndian

public void setLittleEndian(boolean littleEndian)

Sets the littleEndian flag on this metadata. Used to preserve endianness in translation.

populateImageMetadata

public void populateImageMetadata()

Description copied from interface: Metadata

Generates format-agnostic image metadata structures based on this instance's format-specific metadata.

getIdat

public List<APNGFormat.IDATChunk> getIdat()

setIdat

public void setIdat(List<APNGFormat.IDATChunk> idat)

addIdat

public void addIdat(APNGFormat.IDATChunk idat)

getFctl

public List<APNGFormat.FCTLChunk> getFctl()

setFctl

public void setFctl(List<APNGFormat.FCTLChunk> fctl)

getActl

public APNGFormat.ACTLChunk getActl()

setActl

public void setActl(APNGFormat.ACTLChunk actl)

getIhdr

public APNGFormat.IHDRChunk getIhdr()

setIhdr

public void setIhdr(APNGFormat.IHDRChunk ihdr)

getPlte

public APNGFormat.PLTEChunk getPlte()

setPlte

public void setPlte(APNGFormat.PLTEChunk plte)

getIend

public APNGFormat.IENDChunk getIend()

setIend

public void setIend(APNGFormat.IENDChunk iend)

close

public void close(boolean fileOnly)
           throws IOException

Description copied from interface: HasSource

Closes the image source(s) associated with this component, with a toggle to determine if the component itself is reset.

Specified by:

close in interface HasSource

Overrides:

close in class AbstractMetadata

Parameters:

fileOnly - - If true, only the associated source(s) are closed.

Throws:

IOException