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.

Author:

lkuehne

Method Summary

Modifier and Type	Method and Description
String	getAttribute(String name) The attribute value for an attribute name.
String[]	getAttributeNames() The set of attribute names.
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.

Method Detail

getAttributeNames

String[] getAttributeNames()

The set of attribute names.

Returns:

The set of attribute names, never null.

getAttribute

String getAttribute(String name)
             throws CheckstyleException

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

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