Package com.puppycrawl.tools.checkstyle.api

Interface Configuration

All Superinterfaces:

Serializable

All Known Implementing Classes:

DefaultConfiguration

public interface Configuration
extends 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	Description
String	getAttribute(String name)	Deprecated. This shall be removed in future releases.
String[]	getAttributeNames()	Deprecated. This shall be removed in future releases.
Configuration[]	getChildren()	The set of child configurations.
Map<String,String>	getMessages()	Returns an unmodifiable map instance containing the custom messages for this configuration.
String	getName()	The name of this configuration.
String	getProperty(String name)	The property value for property name.
String[]	getPropertyNames()	The set of property names.

Method Detail

getAttributeNames

@Deprecated(since="8.45")
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(since="8.45")
String getAttribute(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

String[] getPropertyNames()

The set of property names.

Returns:

The set of property names, never null.

getProperty

String getProperty(String name)
            throws CheckstyleException

The property value for 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

String getName()

The name of this configuration.

Returns:

The name of this configuration.

getMessages

Map<String,String> getMessages()

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

Returns:

unmodifiable map containing custom messages