View Javadoc
1   ////////////////////////////////////////////////////////////////////////////////
2   // checkstyle: Checks Java source code for adherence to a set of rules.
3   // Copyright (C) 2001-2017 the original author or authors.
4   //
5   // This library is free software; you can redistribute it and/or
6   // modify it under the terms of the GNU Lesser General Public
7   // License as published by the Free Software Foundation; either
8   // version 2.1 of the License, or (at your option) any later version.
9   //
10  // This library is distributed in the hope that it will be useful,
11  // but WITHOUT ANY WARRANTY; without even the implied warranty of
12  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  // Lesser General Public License for more details.
14  //
15  // You should have received a copy of the GNU Lesser General Public
16  // License along with this library; if not, write to the Free Software
17  // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18  ////////////////////////////////////////////////////////////////////////////////
19  
20  package com.puppycrawl.tools.checkstyle;
21  
22  /**
23   * Resolves properties in module configurations.
24   *
25   * <p>The {@link ConfigurationLoader} uses a PropertyResolver to
26   * resolve the values of external properties like {@code ${basename}}
27   * that occur in the configuration file.
28   *
29   * @author lkuehne
30   * @see ConfigurationLoader
31   */
32  @FunctionalInterface
33  public interface PropertyResolver {
34      /**
35       * Resolves a property name to it's value.
36       * @param name the name of the property.
37       * @return the value that is associated with {@code propertyName}.
38       */
39      String resolve(String name);
40  }