Package org.scijava.script
Interface ScriptHeaderService
-
- All Superinterfaces:
Comparable<Prioritized>,Contextual,Disposable,HandlerService<ScriptLanguage,ScriptHeader>,HasPluginInfo,Identifiable,Initializable,Locatable,Logged,Prioritized,PTService<ScriptHeader>,RichPlugin,SciJavaPlugin,SciJavaService,Service,SingletonService<ScriptHeader>,Typed<ScriptLanguage>,TypedService<ScriptLanguage,ScriptHeader>,Versioned
- All Known Implementing Classes:
DefaultScriptHeaderService
public interface ScriptHeaderService extends HandlerService<ScriptLanguage,ScriptHeader>, SciJavaService
Interface for aHandlerServicecapable of mappingScriptLanguages toScriptHeaders.NB: although individual/highest priority handlers can be queried as normal via a
HandlerService, thegetHeader(ScriptLanguage)method will combine the headers for all availableScriptHeaders for a givenScriptLanguage.- Author:
- Mark Hiner
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default StringgetHeader(ScriptLanguage language)Searches for allScriptHeaders capable of handling the givenScriptLanguageand combines the result of theirScriptHeader.getHeader()output to a single string.default Class<ScriptHeader>getPluginType()Gets the type of plugins managed by this service.default Class<ScriptLanguage>getType()Gets the type associated with the object.-
Methods inherited from interface org.scijava.Contextual
context, getContext, setContext
-
Methods inherited from interface org.scijava.Disposable
dispose
-
Methods inherited from interface org.scijava.plugin.HandlerService
getHandler, getInstances, supports
-
Methods inherited from interface org.scijava.plugin.HasPluginInfo
getInfo, setInfo
-
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.PTService
getPlugins, getPluginService, pluginService
-
Methods inherited from interface org.scijava.plugin.RichPlugin
getIdentifier, log
-
Methods inherited from interface org.scijava.service.Service
registerEventHandlers
-
Methods inherited from interface org.scijava.plugin.SingletonService
create, filterInstances, getInstance, initialize, objectService
-
Methods inherited from interface org.scijava.plugin.TypedService
find
-
Methods inherited from interface org.scijava.Versioned
getVersion
-
-
-
-
Method Detail
-
getHeader
default String getHeader(ScriptLanguage language)
Searches for allScriptHeaders capable of handling the givenScriptLanguageand combines the result of theirScriptHeader.getHeader()output to a single string.- Parameters:
language- - Language to look up- Returns:
- The combined header text to insert at the top of a script.
-
getPluginType
default Class<ScriptHeader> getPluginType()
Description copied from interface:PTServiceGets the type of plugins managed by this service.- Specified by:
getPluginTypein interfacePTService<ScriptHeader>
-
getType
default Class<ScriptLanguage> getType()
Description copied from interface:TypedGets the type associated with the object.- Specified by:
getTypein interfaceTyped<ScriptLanguage>
-
-