io.scif

Class AbstractChecker

java.lang.Object

org.scijava.AbstractContextual

org.scijava.plugin.AbstractRichPlugin

io.scif.AbstractSCIFIOPlugin

io.scif.AbstractHasFormat

io.scif.AbstractChecker

All Implemented Interfaces:

Checker, HasFormat, SCIFIOPlugin, 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

Direct Known Subclasses:

APNGFormat.Checker, AVIFormat.Checker, BMPFormat.Checker, DefaultChecker, DICOMFormat.Checker, GIFFormat.Checker, JPEG2000Format.Checker, JPEGFormat.Checker, KontronFormat.Checker, MicromanagerFormat.Checker, MinimalTIFFFormat.Checker, MNGFormat.Checker, NativeQTFormat.Checker, NRRDFormat.Checker, PCXFormat.Checker, PGMFormat.Checker, ScancoISQFormat.Checker, StratecPQCTFormat.Checker, TestImgFormat.Checker

public abstract class AbstractChecker
extends AbstractHasFormat
implements Checker

Abstract superclass of all SCIFIO Checker implementations.

Author:

Mark Hiner

See Also:

Checker, HasFormat

Constructor Summary

Constructors

Constructor and Description
AbstractChecker()

Method Summary

Modifier and Type	Method and Description
boolean	checkHeader(byte[] block) Checks if the given bytes are a valid header for this Format.
boolean	isFormat(org.scijava.io.handle.DataHandle<org.scijava.io.location.Location> stream) Checks if the given stream is a valid stream for this Format.
boolean	isFormat(org.scijava.io.location.Location loc) Checks if the provided image source is compatible with this Format.
boolean	isFormat(org.scijava.io.location.Location loc, SCIFIOConfig config) Checks if the provided image source is compatible with this Format.
boolean	suffixNecessary() Whether the file extension matching one of the format's suffixes is necessary to identify the file as a source compatible with this format.
boolean	suffixSufficient() Whether the file extension matching one of the format's suffixes is sufficient to identify the file as a source compatible with this format.

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 io.scif.HasFormat

getFormat, getFormatName

Methods inherited from interface io.scif.SCIFIOPlugin

getVersion, log

Methods inherited from interface org.scijava.plugin.RichPlugin

getIdentifier

Methods inherited from interface org.scijava.Contextual

context, getContext, setContext

Methods inherited from interface org.scijava.Prioritized

compareTo, getPriority, setPriority

Methods inherited from interface org.scijava.plugin.HasPluginInfo

getInfo, setInfo

Methods inherited from interface org.scijava.Locatable

getLocation

Constructor Detail

AbstractChecker

public AbstractChecker()

Method Detail

suffixNecessary

public boolean suffixNecessary()

Description copied from interface: Checker

Whether the file extension matching one of the format's suffixes is necessary to identify the file as a source compatible with this format.

Specified by:

suffixNecessary in interface Checker

suffixSufficient

public boolean suffixSufficient()

Description copied from interface: Checker

Whether the file extension matching one of the format's suffixes is sufficient to identify the file as a source compatible with this format.

If false, the source will have to be read to determine compatibility.

Specified by:

suffixSufficient in interface Checker

isFormat

public boolean isFormat(org.scijava.io.location.Location loc)

Description copied from interface: Checker

Checks if the provided image source is compatible with this Format. Will not open the source during this process.

Specified by:

isFormat in interface Checker

Parameters:

loc - path to the image source to check.

Returns:

True if the image source is compatible with this Format.

isFormat

public boolean isFormat(org.scijava.io.location.Location loc,
                        SCIFIOConfig config)

Description copied from interface: Checker

Checks if the provided image source is compatible with this Format.

If open is true and the source name is insufficient to determine the image type, the source may be opened for further analysis, or other relatively expensive file system operations (such as file existence tests and directory listings) may be performed.

Specified by:

isFormat in interface Checker

Parameters:

loc - path to the image source to check.

config - SCIFIOConfig for this isFormat call.

Returns:

True if the image source is compatible with this Format.

isFormat

public boolean isFormat(org.scijava.io.handle.DataHandle<org.scijava.io.location.Location> stream)
                 throws IOException

Description copied from interface: Checker

Checks if the given stream is a valid stream for this Format.

Specified by:

isFormat in interface Checker

Parameters:

stream - the image source to check.

Returns:

True if stream is compatible with this Format.

Throws:

IOException

checkHeader

public boolean checkHeader(byte[] block)

Description copied from interface: Checker

Checks if the given bytes are a valid header for this Format.

Specified by:

checkHeader in interface Checker

Parameters:

block - the byte array to check.

Returns:

True if block is compatible with this Format.