001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.apache.shiro.config;
020
021/**
022 * Basic String interpolation interface.  Typically implementations will use the Maven/Ant like notation: ${key}, but
023 * This is up to the implementation.
024 *
025 * @since 1.4
026 */
027public interface Interpolator {
028
029    /**
030     * Interpolates <code>value</code> and returns the result.
031     * @param value the source text
032     * @return the String result of the interpolation, or <code>value</code>, if there was not change.
033     */
034    String interpolate(String value);
035}