ValueSource.java

package org.codehaus.plexus.interpolation;

import java.util.List;

/*
 * Copyright 2001-2008 Codehaus Foundation.
 *
 * 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.
 */

/**
 * Supplies one strategy for resolving a value for an interpolation expression.
 * ValueSources may be stacked.
 */
public interface ValueSource {

    /**
     * Returns a value resolved from an expression. The return value is recursively resolved via {@link Interpolator#interpolate(String)}, i.e. might contain expressions as well.
     * @param expression The string expression.
     * @param expressionStartDelimiter A valid start delimiter of the expression to be used with the calling {@link Interpolator} (by default <code>${</code>).
     * @param expressionEndDelimiter   A valid end delimiter of the expression to be used with the calling {@link Interpolator} (by default <code>}</code>).
     * @return the value related to the expression, or {@code null} if not found. This value might contain other expressions separated by {@code expressionStartDelimiter} and {@code expressionEndDelimiter}
     * @since 1.28
     */
    default Object getValue(String expression, String expressionStartDelimiter, String expressionEndDelimiter) {
        return getValue(expression);
    }

    /**
     * @param expression The string expression.
     * @return the value related to the expression, or {@code null} if not found.
     * @see #getValue(String, String, String)
     */
    public Object getValue(String expression);

    /**
     * Return the feedback about resolution failures for a particular expression.
     *
     * @return a combination of String and Throwable instances, where strings
     * related to throwables are listed first.
     */
    List getFeedback();

    /**
     * Clear the feedback accumulated by a prior interpolation run.
     */
    void clearFeedback();
}