com.puppycrawl.tools.checkstyle.api

Interface Configuration

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

DefaultConfiguration

public interface Configuration
extends java.io.Serializable

A Configuration is used to configure a Configurable component. The general idea of Configuration/Configurable was taken from Jakarta's Avalon framework.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttribute(java.lang.String name) Deprecated. This shall be removed in future releases. Please use getProperty(String name) instead.
java.lang.String[]	getAttributeNames() Deprecated. This shall be removed in future releases. Please use getPropertyNames() instead.
Configuration[]	getChildren() The set of child configurations.
java.util.Map<java.lang.String,java.lang.String>	getMessages() Returns an unmodifiable map instance containing the custom messages for this configuration.
java.lang.String	getName() The name of this configuration.
java.lang.String	getProperty(java.lang.String name) The property value for n property name.
java.lang.String[]	getPropertyNames() The set of property names.

Method Detail

getAttributeNames

@Deprecated
java.lang.String[] getAttributeNames()

Deprecated. This shall be removed in future releases. Please use getPropertyNames() instead.

The set of attribute names.

Returns:

The set of attribute names, never null.

getAttribute

@Deprecated
java.lang.String getAttribute(java.lang.String name)
                                   throws CheckstyleException

Deprecated. This shall be removed in future releases. Please use getProperty(String name) instead.

The attribute value for an attribute name.

Parameters:

name - the attribute name

Returns:

the value that is associated with name

Throws:

CheckstyleException - if name is not a valid attribute name

getPropertyNames

java.lang.String[] getPropertyNames()

The set of property names.

Returns:

The set of property names, never null.

getProperty

java.lang.String getProperty(java.lang.String name)
                      throws CheckstyleException

The property value for n property name.

Parameters:

name - the property name

Returns:

the value that is associated with name

Throws:

CheckstyleException - if name is not a valid property name

getChildren

Configuration[] getChildren()

The set of child configurations.

Returns:

The set of child configurations, never null.

getName

java.lang.String getName()

The name of this configuration.

Returns:

The name of this configuration.

getMessages

java.util.Map<java.lang.String,java.lang.String> getMessages()

Returns an unmodifiable map instance containing the custom messages for this configuration.

Returns:

unmodifiable map containing custom messages