com.github.jknack.handlebars.io.AbstractTemplateLoader 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.io;

import static org.apache.commons.lang3.StringUtils.defaultString;
import static org.apache.commons.lang3.Validate.notNull;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;

/**
 *  
 *  Strategy interface for loading resources from class path, file system, etc.
 *  
 *  Templates prefix and suffix
 *  
 *  A TemplateLoader provides two important properties:
 *  
 *  
 *  prefix: useful for setting a default prefix where templates are stored.
 *  suffix: useful for setting a default suffix or file extension for your templates. Default is:
 *  '.hbs'
 *  
 *
 *  @author edgar.espina
 *  @since 1.0.0
 *
 * @deprecated com.github.jknack.handlebars.io 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 abstract class AbstractTemplateLoader implements TemplateLoader {

    /**
     * The prefix that gets prepended to view names when building a URI.
     */
    private String prefix = DEFAULT_PREFIX;

    /**
     * The suffix that gets appended to view names when building a URI.
     */
    private String suffix = DEFAULT_SUFFIX;

    /**
     * Charset.
     */
    private Charset charset;

    /**
     * Resolve the uri to an absolute location.
     *
     * @param uri The candidate uri.
     * @return Resolve the uri to an absolute location.
     */
    @Override
    public String resolve(final String uri) {
        return prefix + normalize(uri) + suffix;
    }

    /**
     * Normalize the location by removing '/' at the beginning.
     *
     * @param location The candidate location.
     * @return A location without '/' at the beginning.
     */
    protected String normalize(final String location) {
        if (location.toString().startsWith("/")) {
            return location.substring(1);
        }
        return location;
    }

    /**
     * Set the prefix that gets prepended to view names when building a URI.
     *
     * @param prefix The prefix that gets prepended to view names when building a
     *        URI.
     */
    public void setPrefix(final String prefix) {
        this.prefix = notNull(prefix, "A view prefix is required.");
        if (!this.prefix.endsWith("/")) {
            this.prefix += "/";
        }
    }

    /**
     * Set the suffix that gets appended to view names when building a URI.
     *
     * @param suffix The suffix that gets appended to view names when building a
     *        URI.
     */
    public void setSuffix(final String suffix) {
        this.suffix = defaultString(suffix, "");
    }

    @Override
    public void setCharset(final Charset charset) {
        this.charset = notNull(charset, "Charset required.");
    }

    @Override
    public Charset getCharset() {
        return charset == null ? StandardCharsets.UTF_8 : charset;
    }

    /**
     * @return The prefix that gets prepended to view names when building a URI.
     */
    @Override
    public String getPrefix() {
        return prefix;
    }

    /**
     * @return The suffix that gets appended to view names when building a
     *         URI.
     */
    @Override
    public String getSuffix() {
        return suffix;
    }
}