KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > puppycrawl > tools > checkstyle > PropertyResolver


1 ////////////////////////////////////////////////////////////////////////////////
2
// checkstyle: Checks Java source code for adherence to a set of rules.
3
// Copyright (C) 2001-2005 Oliver Burn
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
package com.puppycrawl.tools.checkstyle;
20
21 import com.puppycrawl.tools.checkstyle.api.CheckstyleException;
22
23 /**
24  * Resolves properties in module configurations.
25  *
26  * The {@link ConfigurationLoader} uses a PropertyResolver to
27  * resolve the values of external properties like <code>${basename}</code>
28  * that occur in the configuration file.
29  *
30  * @see ConfigurationLoader
31  * @author lkuehne
32  */

33 public interface PropertyResolver
34 {
35     /**
36      * Resolves a property name to it's value.
37      * @param aName the name of the property.
38      * @return the value that is associated with <code>propertyName</code>.
39      * @throws CheckstyleException if the propertyName cannot be reolved
40      */

41     String JavaDoc resolve(String JavaDoc aName)
42         throws CheckstyleException;
43 }
44
Popular Tags