Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## 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.
`java.lang.String` | `getName()` The name of this configuration.

Method Detail

### getAttributeNames

    public java.lang.String[] getAttributeNames()

  The set of attribute names.

  Returns:
    The set of attribute names, never null.

### getAttribute

    public 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

    public Configuration[] getChildren()

  The set of child configurations.

  Returns:
    The set of child configurations, never null.

### getName

    public java.lang.String getName()

  The name of this configuration.

  Returns:
    The name of this configuration.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Back to the Checkstyle Home Page
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD