io.scif

Class AbstractHasFormat

java.lang.Object

org.scijava.AbstractContextual

org.scijava.plugin.AbstractRichPlugin

io.scif.AbstractSCIFIOPlugin

io.scif.AbstractHasFormat

All Implemented Interfaces:

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:

AbstractChecker, AbstractHasSource

public abstract class AbstractHasFormat
extends AbstractSCIFIOPlugin
implements HasFormat

Abstract superclass for all classes that implement HasFormat.

Author:

Mark Hiner

See Also:

HasFormat, FormatService

Constructor Summary

Constructors

Constructor and Description
AbstractHasFormat()

Method Summary

Modifier and Type	Method and Description
protected org.scijava.io.location.BrowsableLocation	asBrowsableLocation(org.scijava.io.handle.DataHandle<org.scijava.io.location.Location> handle) Convenience overload of asBrowsableLocation(Location) that operates on a handle.
protected org.scijava.io.location.BrowsableLocation	asBrowsableLocation(org.scijava.io.location.Location loc) Safely casts a Location to a BrowsableLocation, throwing a FormatException if the cast is not possible.
Format	getFormat() Provides a link back to the format associated with this component.
String	getFormatName() Helper method for accessing Format.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.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

AbstractHasFormat

public AbstractHasFormat()

Method Detail

getFormat

public Format getFormat()

Description copied from interface: HasFormat

Provides a link back to the format associated with this component.

Specified by:

getFormat in interface HasFormat

Returns:

the associated Format

getFormatName

public String getFormatName()

Description copied from interface: HasFormat

Helper method for accessing Format.getFormatName(). Some Formats may be polymorphic and wish to provide additional name information based on the specific dataset open - this method allows overriding of that behavior.

Specified by:

getFormatName in interface HasFormat

Returns:

the name of the associated Format

asBrowsableLocation

protected org.scijava.io.location.BrowsableLocation asBrowsableLocation(org.scijava.io.location.Location loc)
                                                                 throws FormatException

Safely casts a Location to a BrowsableLocation, throwing a FormatException if the cast is not possible.

Parameters:

loc - the location to cast to BrowsableLocation

Throws:

FormatException

asBrowsableLocation

protected org.scijava.io.location.BrowsableLocation asBrowsableLocation(org.scijava.io.handle.DataHandle<org.scijava.io.location.Location> handle)
                                                                 throws FormatException

Convenience overload of asBrowsableLocation(Location) that operates on a handle.

Parameters:

handle -

Throws:

FormatException