org.scijava.text

Interface TextFormat

All Superinterfaces:

Comparable<Prioritized>, Contextual, HandlerPlugin<File>, HasPluginInfo, Prioritized, RichPlugin, SciJavaPlugin, SingletonPlugin, Typed<File>, TypedPlugin<File>

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

Methods

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.

Methods inherited from interface org.scijava.Contextual

context, getContext, setContext

Methods inherited from interface org.scijava.Prioritized

getPriority, setPriority

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.scijava.plugin.HasPluginInfo

getInfo, setInfo

Methods inherited from interface org.scijava.Typed

getType, supports

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.