com.github.jknack.handlebars.HelperRegistry Maven / Gradle / Ivy
/**
* Copyright (c) 2012-2015 Edgar Espina
*
* This file is part of Handlebars.java.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* This copy of Woodstox XML processor is licensed under the
* Apache (Software) License, version 2.0 ("the License").
* See the License for details about distribution rights, and the
* specific rights regarding derivate works.
*
* You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/
*
* A copy is also included in the downloadable source code package
* containing Woodstox, in file "ASL2.0", under the same directory
* as this file.
*/
package com.github.jknack.handlebars;
import java.io.File;
import java.io.InputStream;
import java.io.Reader;
import java.net.URI;
import java.util.Map.Entry;
import java.util.Set;
/**
* The helper registry.
*
* @author edgar
* @since 1.2.0
*/
public interface HelperRegistry {
/**
* The missing helper's name.
*/
String HELPER_MISSING = "helperMissing";
/**
* Find a helper by name.
*
* @param The helper runtime type.
* @param name The helper's name. Required.
* @return A helper or null if it's not found.
*/
Helper helper(String name);
/**
* List all the helpers from registry.
*
* @return Available helpers in the registry.
*/
Set>> helpers();
/**
* Register a helper in the helper registry.
*
* @param The helper runtime type.
* @param name The helper's name. Required.
* @param helper The helper object. Required.
* @return This handlebars.
*/
HelperRegistry registerHelper(String name, Helper helper);
/**
* Register the special helper missing in the registry.
*
* @param The helper runtime type.
* @param helper The helper object. Required.
* @return This handlebars.
*/
HelperRegistry registerHelperMissing(final Helper helper);
/**
*
* Register all the helper methods for the given helper source.
*
*
* A helper method looks like:
*
*
*
* public static? CharSequence methodName(context?, parameter*, options?) {
* }
*
*
* Where:
*
* - A method can/can't be static
* - The method's name became the helper's name
* - Context, parameters and options are all optional
* - If context and options are present they must be the first and last method arguments.
*
*
* Instance and static methods will be registered as helpers.
*
* @param helperSource The helper source. Required.
* @return This handlebars object.
*/
HelperRegistry registerHelpers(Object helperSource);
/**
*
* Register all the helper methods for the given helper source.
*
*
* A helper method looks like:
*
*
*
* public static? CharSequence methodName(context?, parameter*, options?) {
* }
*
*
* Where:
*
* - A method can/can't be static
* - The method's name became the helper's name
* - Context, parameters and options are all optional
* - If context and options are present they must be the first and last method arguments.
*
*
* Only static methods will be registered as helpers.
*
* Enums are supported too
*
*
* @param helperSource The helper source. Enums are supported. Required.
* @return This handlebars object.
*/
HelperRegistry registerHelpers(Class helperSource);
/**
*
* Register helpers from a JavaScript source.
*
*
* A JavaScript source file looks like:
*
*
*
* Handlebars.registerHelper('hey', function (context) {
* return 'Hi ' + context.name;
* });
* ...
* Handlebars.registerHelper('hey', function (context, options) {
* return 'Hi ' + context.name + options.hash['x'];
* });
* ...
* Handlebars.registerHelper('hey', function (context, p1, p2, options) {
* return 'Hi ' + context.name + p1 + p2 + options.hash['x'];
* });
* ...
*
*
* To keep your helpers reusable between server and client avoid DOM manipulation.
*
* @param location A classpath location. Required.
* @return This handlebars object.
* @throws Exception If the JavaScript helpers can't be registered.
*/
HelperRegistry registerHelpers(URI location) throws Exception;
/**
*
* Register helpers from a JavaScript source.
*
*
* A JavaScript source file looks like:
*
*
*
* Handlebars.registerHelper('hey', function (context) {
* return 'Hi ' + context.name;
* });
* ...
* Handlebars.registerHelper('hey', function (context, options) {
* return 'Hi ' + context.name + options.hash['x'];
* });
* ...
* Handlebars.registerHelper('hey', function (context, p1, p2, options) {
* return 'Hi ' + context.name + p1 + p2 + options.hash['x'];
* });
* ...
*
*
* To keep your helpers reusable between server and client avoid DOM manipulation.
*
* @param input A JavaScript file name. Required.
* @return This handlebars object.
* @throws Exception If the JavaScript helpers can't be registered.
*/
HelperRegistry registerHelpers(File input) throws Exception;
/**
*
* Register helpers from a JavaScript source.
*
*
* A JavaScript source file looks like:
*
*
*
* Handlebars.registerHelper('hey', function (context) {
* return 'Hi ' + context.name;
* });
* ...
* Handlebars.registerHelper('hey', function (context, options) {
* return 'Hi ' + context.name + options.hash['x'];
* });
* ...
* Handlebars.registerHelper('hey', function (context, p1, p2, options) {
* return 'Hi ' + context.name + p1 + p2 + options.hash['x'];
* });
* ...
*
*
* To keep your helpers reusable between server and client avoid DOM manipulation.
*
* @param filename The file name (just for debugging purpose). Required.
* @param source The JavaScript source. Required.
* @return This handlebars object.
* @throws Exception If the JavaScript helpers can't be registered.
*/
HelperRegistry registerHelpers(String filename, Reader source) throws Exception;
/**
*
* Register helpers from a JavaScript source.
*
*
* A JavaScript source file looks like:
*
*
*
* Handlebars.registerHelper('hey', function (context) {
* return 'Hi ' + context.name;
* });
* ...
* Handlebars.registerHelper('hey', function (context, options) {
* return 'Hi ' + context.name + options.hash['x'];
* });
* ...
* Handlebars.registerHelper('hey', function (context, p1, p2, options) {
* return 'Hi ' + context.name + p1 + p2 + options.hash['x'];
* });
* ...
*
*
* To keep your helpers reusable between server and client avoid DOM manipulation.
*
* @param filename The file name (just for debugging purpose). Required.
* @param source The JavaScript source. Required.
* @return This handlebars object.
* @throws Exception If the JavaScript helpers can't be registered.
*/
HelperRegistry registerHelpers(String filename, InputStream source)
throws Exception;
/**
*
* Register helpers from a JavaScript source.
*
*
* A JavaScript source file looks like:
*
*
*
* Handlebars.registerHelper('hey', function (context) {
* return 'Hi ' + context.name;
* });
* ...
* Handlebars.registerHelper('hey', function (context, options) {
* return 'Hi ' + context.name + options.hash['x'];
* });
* ...
* Handlebars.registerHelper('hey', function (context, p1, p2, options) {
* return 'Hi ' + context.name + p1 + p2 + options.hash['x'];
* });
* ...
*
*
* To keep your helpers reusable between server and client avoid DOM manipulation.
*
* @param filename The file name (just for debugging purpose). Required.
* @param source The JavaScript source. Required.
* @return This registry.
* @throws Exception If the JavaScript helpers can't be registered.
*/
HelperRegistry registerHelpers(String filename, String source) throws Exception;
/**
* Find a decorator by name.
*
* @param name A decorator's name.
* @return A decorator or null.
* @since 4.0.0
*/
Decorator decorator(String name);
/**
* Register a decorator and make it accessible via {@link #decorator(String)}.
*
* @param name A decorator's name. Required.
* @param decorator A decorator. Required.
* @return This registry.
* @since 4.0.0
*/
HelperRegistry registerDecorator(String name, Decorator decorator);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy