Package com.github.jknack.handlebars.helper

Class WithHelper

  • All Implemented Interfaces:
    Helper<java.lang.Object>
    public class WithHelper
extends java.lang.Object
implements Helper<java.lang.Object>

    Normally, Handlebars templates are evaluated against the context passed into the compiled method.

    You can shift the context for a section of a template by using the built-in with block helper.

    Since:
    0.3.0

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static Helper<java.lang.Object> INSTANCE
      A singleton instance of this helper.
      static java.lang.String NAME
      The helper's name.

    • Constructor Summary

      Constructors 
      Constructor Description
      WithHelper()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Object apply​(java.lang.Object context, Options options)
      Apply the helper to the context.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • INSTANCE

        public static final Helper<java.lang.Object> INSTANCE
        A singleton instance of this helper.

    • Constructor Detail

      • WithHelper

        public WithHelper()

    • Method Detail

      • apply

        public java.lang.Object apply​(java.lang.Object context,
                              Options options)
                       throws java.io.IOException
        Description copied from interface: Helper
        Apply the helper to the context.
        Specified by:
        apply in interface Helper<java.lang.Object>
        Parameters:
        context - The context object.
        options - The options object.
        Returns:
        A string result.
        Throws:
        java.io.IOException - If a template cannot be loaded.