Package com.terminalfour.publish.handlebars.helper

Class BaseHelper

java.lang.Object

com.terminalfour.publish.handlebars.helper.BaseHelper

All Implemented Interfaces:

com.github.jknack.handlebars.Helper<Object>

Direct Known Subclasses:

AnchorHandlebarsHelper, CanonicalURLHandlebarsHelper, ChannelDescriptionHandlebarsHelper, ChannelIdHandlebarsHelper, ChannelNameHandlebarsHelper, ContentIdHandlebarsHelper, ContentLastModifiedDateHandlebarsHelper, ContentVersionHandlebarsHelper, CreateContentHandlebarsHelper, CreateDateHandlebarsHelper, CreateSectionHandlebarsHelper, DateElementHandlebarsHelper, DateFormatHandlebarsHelper, DirectEditSectionHandlebarsHelper, EditContentHandlebarsHelper, EditSectionHandlebarsHelper, EmbedHandlebarsHelper, EqHandlebarsHelper, ExpiryDateHandlebarsHelper, FileHandlebarsHelper, FilesizeHandlebarsHelper, FirstHandlebarsHelper, FirstInSequenceHandlebarsHelper, FirstOfTypeHandlebarsHelper, FormHandlebarsHelper, FulltextHandlebarsHelper, IfSetHandlebarsHelper, LanguageCodeHandlebarsHelper, LanguageLinkHandlebarsHelper, LastHandlebarsHelper, LastInSequenceHandlebarsHelper, LastOfTypeHandlebarsHelper, LinkHandlebarsHelper, ListByIdHandlebarsHelper, ListHandlebarsHelper, MediaHandlebarsHelper, MediaIdHandlebarsHelper, MetaHandlebarsHelper, NavHandlebarsHelper, NeqHandlebarsHelper, Nl2brHandlebarsHelper, PageLayoutIdHandlebarsHelper, PageURLHandlebarsHelper, PreviewHandlebarsHelper, PreviewURLHandlebarsHelper, ProcessHandlebarsHelper, PublishDateHandlebarsHelper, PublishHandlebarsHelper, PublishURLHandlebarsHelper, RawHandlebarsHelper, ScaleHandlebarsHelper, SectionHandlebarsHelper, SectionIdHandlebarsHelper, SectionLevelHandlebarsHelper, SectionNameHandlebarsHelper, SelectedHandlebarsHelper, SelectedNamesHandlebarsHelper, SelectedValuesHandlebarsHelper, SnippetHandlebarsHelper

public abstract class BaseHelper
extends Object
implements com.github.jknack.handlebars.Helper<Object>

This class is the base class from which all handlebars.java helpers should extend.

Constructor Summary

Constructors

Constructor	Description
BaseHelper()

Method Summary

Modifier and Type	Method	Description
abstract Object	apply(Object context, com.github.jknack.handlebars.Options options)	The apply method is the main entry point for handlebars.java helpers.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BaseHelper

public BaseHelper()

Method Detail

apply

public abstract Object apply(Object context,
                             com.github.jknack.handlebars.Options options)
                      throws IOException

The apply method is the main entry point for handlebars.java helpers.

It is called internally by the handlebars.java engine when a matching handlebars.java expression is encountered.

Specified by:

apply in interface com.github.jknack.handlebars.Helper<Object>

Parameters:

context - The currently executing context.

options - The options.

Returns:

The generated output.

Throws:

IOException - If processing of the expressions fails.