com.github.jknack.handlebars.ValueResolver 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 static java.util.Arrays.asList;
import static java.util.Collections.unmodifiableList;
import java.util.List;
import java.util.Map.Entry;
import java.util.Set;
import com.github.jknack.handlebars.context.JavaBeanValueResolver;
import com.github.jknack.handlebars.context.MapValueResolver;
import com.github.jknack.handlebars.context.MethodValueResolver;

/**
 *  A hook interface for resolving values from the {@link Context context stack}.
 *
 *  @author edgar.espina
 *  @since 0.1.1
 *
 * @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 ValueResolver {

    /**
     * A mark object.
     */
    Object UNRESOLVED = new Object();

    /**
     * Resolve the attribute's name in the context object. If a {@link #UNRESOLVED} is returned, the
     * {@link Context context stack} will
     * continue with the next value resolver in the chain.
     *
     * @param context The context object. Not null.
     * @param name The attribute's name. Not null.
     * @return A {@link #UNRESOLVED} is returned, the {@link Context context
     *         stack} will continue with the next value resolver in the chain.
     *         Otherwise, it returns the associated value.
     */
    Object resolve(Object context, String name);

    /**
     * Resolve the the context object by optionally converting the value if necessary.
     * If a {@link #UNRESOLVED} is returned, the {@link Context context stack} will continue with
     * the next value resolver in the chain.
     *
     * @param context The context object. Not null.
     * @return A {@link #UNRESOLVED} is returned, the {@link Context context
     *         stack} will continue with the next value resolver in the chain.
     *         Otherwise, it returns the associated value.
     */
    Object resolve(Object context);

    /**
     * List all the properties and their values for the given object.
     *
     * @param context The context object. Not null.
     * @return All the properties and their values for the given object.
     */
    Set> propertySet(Object context);

    /**
     * Default value resolvers. Including:
     *
     * - {@link MapValueResolver}
     * - {@link JavaBeanValueResolver}
     * - {@link MethodValueResolver}. On Java 14 or higher.
     *
     * @return Immutable list of value resolvers.
     */
    static List defaultValueResolvers() {
        if (Handlebars.Utils.javaVersion14) {
            return unmodifiableList(asList(MapValueResolver.INSTANCE, JavaBeanValueResolver.INSTANCE, MethodValueResolver.INSTANCE));
        }
        return unmodifiableList(asList(MapValueResolver.INSTANCE, JavaBeanValueResolver.INSTANCE));
    }
}