org.scijava.text

Interface TextFormat

All Superinterfaces:

Comparable<Prioritized>, Contextual, HandlerPlugin<File>, HasPluginInfo, Identifiable, Locatable, Logged, Prioritized, RichPlugin, SciJavaPlugin, SingletonPlugin, Typed<File>, TypedPlugin<File>, Versioned

All Known Implementing Classes:

AbstractTextFormat

public interface TextFormat
extends HandlerPlugin<File>

TextFormat is a plugin that provides handling for a text markup language.

Text formats discoverable at runtime must implement this interface and be annotated with @Plugin with attribute Plugin.type() = TextFormat.class. While it possible to create a text format merely by implementing this interface, it is encouraged to instead extend AbstractTextFormat, for convenience.

Author:

Curtis Rueden

See Also:

Plugin, TextService

Method Summary

Modifier and Type	Method and Description
String	asHTML(String text) Expresses the given text string in HTML format.
List<String>	getExtensions() Gets the list of filename extensions for text in this format.
default Class<File>	getType() Gets the type associated with the object.
default boolean	supports(File file) Gets whether this object is compatible with the given data object.

Methods inherited from interface org.scijava.plugin.RichPlugin

getIdentifier, log

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

Methods inherited from interface org.scijava.Versioned

getVersion

Method Detail

getExtensions

List<String> getExtensions()

Gets the list of filename extensions for text in this format.

asHTML

String asHTML(String text)

Expresses the given text string in HTML format.

supports

default boolean supports(File file)

Description copied from interface: Typed

Gets whether this object is compatible with the given data object.

By default, this method will return true iff the data is assignable to the associated type given by Typed.getType(). But individual implementations may have other requirements beyond class assignability.

Specified by:

supports in interface Typed<File>

getType

default Class<File> getType()

Description copied from interface: Typed

Gets the type associated with the object.

Specified by:

getType in interface Typed<File>