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.

Author:
lkuehne

Method Summary
 java.lang.String getAttribute(java.lang.String aName)
          The attribute value for an attribute name.
 java.lang.String[] getAttributeNames()
          The set of attribute names.
 Configuration[] getChildren()
          The set of child configurations.
 com.google.common.collect.ImmutableMap<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.
 

Method Detail

getAttributeNames

java.lang.String[] getAttributeNames()
The set of attribute names.

Returns:
The set of attribute names, never null.

getAttribute

java.lang.String getAttribute(java.lang.String aName)
                              throws CheckstyleException
The attribute value for an attribute name.

Parameters:
aName - the attribute name
Returns:
the value that is associated with aName
Throws:
CheckstyleException - if aName is not a valid attribute 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

com.google.common.collect.ImmutableMap<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


Copyright © 2001-2011. All Rights Reserved.