All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.github.jknack.handlebars.helper.PartialHelper 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.
 */
package com.github.jknack.handlebars.helper;

import static org.apache.commons.lang3.Validate.isTrue;
import java.io.IOException;
import com.github.jknack.handlebars.Context;
import com.github.jknack.handlebars.Helper;
import com.github.jknack.handlebars.Options;

/**
 *  The partial registry helper. It stores templates in the current execution
 *  context. Later the {@link BlockHelper} helper read the registry and apply the
 *  template.
 *
 *  @author edgar.espina
 *  @since 0.3.0
 *
 * @deprecated com.github.jknack.handlebars.helper 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 class PartialHelper implements Helper {

    /**
     * A singleton instance of this helper.
     */
    public static final Helper INSTANCE = new PartialHelper();

    /**
     * The helper's name.
     */
    public static final String NAME = "partial";

    @Override
    public Object apply(final Object context, final Options options) throws IOException {
        isTrue(context instanceof String, "found '%s', expected 'partial's name'", context);
        options.partial((String) context, options.fn);
        options.data(Context.PARTIALS + "#" + context + "#hash", options.hash);
        options.data(Context.PARTIALS + "#" + context + "#type", options.tagType);
        return null;
    }
}