net.sf.javadocbuilder
Interface ITemplateSource

All Known Implementing Classes:

FilesystemTemplateSource, InternalTemplateSource, WorkspaceTemplateSource

public interface ITemplateSource

main interface for template sources.

Author:

mike

See Also:

ITemplate

Method Summary

java.lang.String	getDescription() A brief description of this template source.
java.lang.String	getId() A string that uniquely identifies the extension (suggested plugin id).
java.lang.String	getName() Gets the visible name of the template source
net.sf.javadocbuilder.ITemplate	getTemplateById(java.lang.String id) Gets the first template identified by the given name.
net.sf.javadocbuilder.ITemplate[]	getTemplates() Gets an array of all templates available at the template source.

Method Detail

getTemplates

public net.sf.javadocbuilder.ITemplate[] getTemplates()

Gets an array of all templates available at the template source.

Returns:

a non null array (may be zero sized if there are no templates available)

getTemplateById

public net.sf.javadocbuilder.ITemplate getTemplateById(java.lang.String id)

Gets the first template identified by the given name.

Returns:

a template with the given name or null if there's no tempalte with the given name in this source

getName

public java.lang.String getName()

Gets the visible name of the template source

Returns:

getDescription

public java.lang.String getDescription()

A brief description of this template source.

Returns:

getId

public java.lang.String getId()

A string that uniquely identifies the extension (suggested plugin id). The plugin id cannot be used one plugin provides more than one source, in this case the plugin id concateated with a number or a string identifying the source should be enough.

Returns: