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

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getAttribute​(java.lang.String name)
      The attribute value for an attribute name.
      java.lang.String[] getAttributeNames()
      The set of attribute names.
      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.
    • 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 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

        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