io.neba.api.spi.PlaceholderVariableResolver Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of io.neba.neba-api Show documentation

Contains all annotations, tag libraries and lifecycle callback interfaces of NEBA. All packages of this API bundle are exported. Change to the API that are not byte code compatible only occur in major revisions.

There is a newer version: 5.2.3

Show newest version

/*
  Copyright 2013 the original author or authors.

  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 io.neba.api.spi;

import javax.annotation.Nonnull;

/**
 * A source for values of variables of the form ${key}, as
 * supported by the {@link io.neba.api.annotations.Path} annotation.
 *
 * @author Olaf Otto
 * @since 1.0.0
 */
public interface PlaceholderVariableResolver {
    /**
     * Invoked to resolve variables of the form ${name}.
     * Example: For ${name}, invoked with "name".
     *
     * @param variableName never null.
     * @return the resolved value, or null if no value can be resolved for the
     * variable name.
     */
    String resolve(@Nonnull String variableName);
}