com.github.jknack.handlebars.Template Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aem-sdk-api Show documentation
The Adobe Experience Manager SDK
There is a newer version: 2024.11.18751.20241128T090041Z-241100
/**
 * 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.
 */
package com.github.jknack.handlebars;

import java.io.IOException;
import java.io.Writer;
import java.util.Collections;
import java.util.List;

/**
 *  A compiled template created by {@link Handlebars#compileInline(String)}.
 *
 *  @author edgar.espina
 *  @since 0.1.0
 *
 * @deprecated com.github.jknack.handlebars package is deprecated and marked for removal in subsequent releases which will involve removal of the handlebars dependency in AEM.
 */
@Deprecated(since = "2024-07-10")
public interface Template {

    /**
     * An empty template implementation.
     */
    Template EMPTY = new Template() {

        @Override
        public String text() {
            return "";
        }

        @Override
        public String apply(final Object context) throws IOException {
            return "";
        }

        @Override
        public String apply(final Context context) throws IOException {
            return "";
        }

        @Override
        public void apply(final Context context, final Writer writer) throws IOException {
        }

        @Override
        public void apply(final Object context, final Writer writer) throws IOException {
        }

        @Override
        public String toJavaScript() {
            return "";
        }

        @Override
        public String filename() {
            return "";
        }

        @Override
        public int[] position() {
            return new int[] { 0, 0 };
        }

        @SuppressWarnings({ "rawtypes", "unchecked" })
        @Override
        public  TypeSafeTemplate as() {
            TypeSafeTemplate template = as(TypeSafeTemplate.class);
            return template;
        }

        @SuppressWarnings("unchecked")
        @Override
        public > S as(final Class rootType) {
            TypeSafeTemplate template = new TypeSafeTemplate() {

                @Override
                public String apply(final T context) throws IOException {
                    return "";
                }

                @Override
                public void apply(final T context, final Writer writer) throws IOException {
                }
            };
            return (S) template;
        }

        @Override
        public List collect(final TagType... tagType) {
            return Collections.emptyList();
        }

        @Override
        public List collectReferenceParameters() {
            return Collections.emptyList();
        }
    };

    /**
     * Merge the template tree using the given context.
     *
     * @param context The context object. May be null.
     * @param writer The writer object. Required.
     * @throws IOException If a resource cannot be loaded.
     */
    void apply(Object context, Writer writer) throws IOException;

    /**
     * Merge the template tree using the given context.
     *
     * @param context The context object. May be null.
     * @return The resulting template.
     * @throws IOException If a resource cannot be loaded.
     */
    String apply(Object context) throws IOException;

    /**
     * Merge the template tree using the given context.
     *
     * @param context The context object. Required.
     * @param writer The writer object. Required.
     * @throws IOException If a resource cannot be loaded.
     */
    void apply(Context context, Writer writer) throws IOException;

    /**
     * Merge the template tree using the given context.
     *
     * @param context The context object. Required.
     * @return The resulting template.
     * @throws IOException If a resource cannot be loaded.
     */
    String apply(Context context) throws IOException;

    /**
     * Provide the raw text.
     *
     * @return The raw text.
     */
    String text();

    /**
     * Convert this template to JavaScript template (a.k.a precompiled template). Compilation is done
     * by handlebars.js and a JS Engine (usually Rhino).
     *
     * @return A pre-compiled JavaScript version of this template.
     */
    String toJavaScript();

    /**
     * Creates a new {@link TypeSafeTemplate}.
     *
     * @param type The template type. Required.
     * @param  The root type.
     * @param  The template type.
     * @return A new {@link TypeSafeTemplate}.
     */
    > S as(Class type);

    /**
     * Creates a new {@link TypeSafeTemplate}.
     *
     * @param  The root type.
     * @return A new {@link TypeSafeTemplate}.
     */
     TypeSafeTemplate as();

    /**
     * Collect all the tag names under the given tagType.
     * 
     * Usage:
     * 
     *
     *      * {{hello}}
     * {{var 1}}
     * {{{tripleVar}}}
     * 
     * 
     * collect(TagType.VAR) returns [hello, var]
     * 
     * 
     * collect(TagType.TRIPLE_VAR) returns [tripleVar]
     * 
     * 
     * collect(TagType.VAR, TagType.TRIPLE_VAR) returns
     * [hello, var, tripleVar]
     * 
     *
     * @param tagType The tag type. Required.
     * @return A list with tag names.
     */
    List collect(TagType... tagType);

    /**
     * Collects all the parameters which are also variables.
     * 
     * Usage:
     * 
     *
     *      * {{#if v1}}{{/if}}
     * {{#each v2 "test"}}{{/each}}
     * 
     * 
     * collectReferenceParameters() returns [v1, v2]
     * 
     *
     * @return A list with reference parameter names.
     */
    List collectReferenceParameters();

    /**
     * @return The template file's name.
     */
    String filename();

    /**
     * @return The line and column where the template was found.
     */
    int[] position();
}