Package com.github.jknack.handlebars.helper

Class EmbeddedHelper

  • All Implemented Interfaces:
    Helper<java.lang.String>
    public class EmbeddedHelper
extends java.lang.Object
implements Helper<java.lang.String>
    Given: home.hbs 
     <html>
 ...
 {{emdedded "user" ["id"]}}
 </html>
    where user.hbs is: 
     <tr>
 <td>{{firstName}}</td>
 <td>{{lastName}}</td>
 </tr>
    expected output is: 
     <script id="user-hbs" type="text/x-handlebars-template">
 <tr>
 <td>{{firstName}}</td>
 <td>{{lastName}}</td>
 </tr>
 </script>
    Optionally, a user can set the template's name: 
     {{emdedded "user" "user-tmpl" }}
    expected output is: 
     <script id="user-tmpl" type="text/x-handlebars-template">
 <tr>
 <td>{{firstName}}</td>
 <td>{{lastName}}</td>
 </tr>
 </script>
    Since:
    0.3.0

    • Field Summary

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

    • Constructor Summary

      Constructors 
      Constructor Description
      EmbeddedHelper()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Object apply​(java.lang.String path, 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.String> INSTANCE
        A singleton instance of this helper.

    • Constructor Detail

      • EmbeddedHelper

        public EmbeddedHelper()

    • Method Detail

      • apply

        public java.lang.Object apply​(java.lang.String path,
                              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.String>
        Parameters:
        path - The context object.
        options - The options object.
        Returns:
        A string result.
        Throws:
        java.io.IOException - If a template cannot be loaded.