com.puppycrawl.tools.checkstyle.api.Configuration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of checkstyle Show documentation
Checkstyle is a development tool to help programmers write Java code that adheres to a coding standard
The newest version!
///////////////////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code and other text files for adherence to a set of rules.
// Copyright (C) 2001-2024 the original author or authors.
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
///////////////////////////////////////////////////////////////////////////////////////////////

package com.puppycrawl.tools.checkstyle.api;

import java.io.Serializable;
import java.util.Map;

/**
 * A Configuration is used to configure a Configurable component.  The general
 * idea of Configuration/Configurable was taken from Jakarta's Avalon framework.
 */
public interface Configuration extends Serializable {

    /**
     * The set of attribute names.
     *
     * @return The set of attribute names, never null.
     * @deprecated This shall be removed in future releases. Please use
     *      {@code getPropertyNames()} instead.
     */
    @Deprecated(since = "8.45")
    String[] getAttributeNames();

    /**
     * The attribute value for an attribute name.
     *
     * @param name the attribute name
     * @return the value that is associated with name
     * @throws CheckstyleException if name is not a valid attribute name
     * @deprecated This shall be removed in future releases. Please use
     *      {@code getProperty(String name)} instead.
     */
    @Deprecated(since = "8.45")
    String getAttribute(String name) throws CheckstyleException;

    /**
     * The set of property names.
     *
     * @return The set of property names, never null.
     */
    String[] getPropertyNames();

    /**
     * The property value for property name.
     *
     * @param name the property name
     * @return the value that is associated with name
     * @throws CheckstyleException if name is not a valid property name
     */
    String getProperty(String name) throws CheckstyleException;

    /**
     * The set of child configurations.
     *
     * @return The set of child configurations, never null.
     */
    Configuration[] getChildren();

    /**
     * The name of this configuration.
     *
     * @return The name of this configuration.
     */
    String getName();

    /**
     * Returns an unmodifiable map instance containing the custom messages
     * for this configuration.
     *
     * @return unmodifiable map containing custom messages
     */
    Map getMessages();

}