001////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code for adherence to a set of rules.
003// Copyright (C) 2001-2018 the original author or authors.
004//
005// This library is free software; you can redistribute it and/or
006// modify it under the terms of the GNU Lesser General Public
007// License as published by the Free Software Foundation; either
008// version 2.1 of the License, or (at your option) any later version.
009//
010// This library is distributed in the hope that it will be useful,
011// but WITHOUT ANY WARRANTY; without even the implied warranty of
012// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
013// Lesser General Public License for more details.
014//
015// You should have received a copy of the GNU Lesser General Public
016// License along with this library; if not, write to the Free Software
017// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
018////////////////////////////////////////////////////////////////////////////////
019
020package com.puppycrawl.tools.checkstyle;
021
022/**
023 * Resolves properties in module configurations.
024 *
025 * <p>The {@link ConfigurationLoader} uses a PropertyResolver to
026 * resolve the values of external properties like {@code ${basename}}
027 * that occur in the configuration file.
028 *
029 * @author lkuehne
030 * @see ConfigurationLoader
031 */
032@FunctionalInterface
033public interface PropertyResolver {
034
035    /**
036     * Resolves a property name to it's value.
037     * @param name the name of the property.
038     * @return the value that is associated with {@code propertyName}.
039     */
040    String resolve(String name);
041
042}