Class AutomaticBean

    • Field Detail

      • COMMA_SEPARATOR

        private static final java.lang.String COMMA_SEPARATOR
        Comma separator for StringTokenizer.
        See Also:
        Constant Field Values
      • configuration

        private Configuration configuration
        The configuration of this bean.
    • Constructor Detail

      • AutomaticBean

        public AutomaticBean()
    • Method Detail

      • finishLocalSetup

        protected abstract void finishLocalSetup()
                                          throws CheckstyleException
        Provides a hook to finish the part of this component's setup that was not handled by the bean introspection.

        The default implementation does nothing.

        Throws:
        CheckstyleException - if there is a configuration error.
      • createBeanUtilsBean

        private static org.apache.commons.beanutils.BeanUtilsBean createBeanUtilsBean()
        Creates a BeanUtilsBean that is configured to use type converters that throw a ConversionException instead of using the default value when something goes wrong.
        Returns:
        a configured BeanUtilsBean
      • registerIntegralTypes

        private static void registerIntegralTypes​(org.apache.commons.beanutils.ConvertUtilsBean cub)
        Register basic types of JDK like boolean, int, and String to use with BeanUtils. All these types are found in the java.lang package.
        Parameters:
        cub - Instance of ConvertUtilsBean to register types with.
      • registerCustomTypes

        private static void registerCustomTypes​(org.apache.commons.beanutils.ConvertUtilsBean cub)
        Register custom types of JDK like URI and Checkstyle specific classes to use with BeanUtils. None of these types should be found in the java.lang package.
        Parameters:
        cub - Instance of ConvertUtilsBean to register types with.
      • tryCopyProperty

        private void tryCopyProperty​(java.lang.String key,
                                     java.lang.Object value,
                                     boolean recheck)
                              throws CheckstyleException
        Recheck property and try to copy it.
        Parameters:
        key - key of value
        value - value
        recheck - whether to check for property existence before copy
        Throws:
        CheckstyleException - when property defined incorrectly
      • getConfiguration

        protected final Configuration getConfiguration()
        Returns the configuration that was used to configure this component.
        Returns:
        the configuration that was used to configure this component.
      • setupChild

        protected void setupChild​(Configuration childConf)
                           throws CheckstyleException
        Called by configure() for every child of this component's Configuration.

        The default implementation throws CheckstyleException if childConf is null because it doesn't support children. It must be overridden to validate and support children that are wanted.

        Parameters:
        childConf - a child of this component's Configuration
        Throws:
        CheckstyleException - if there is a configuration error.
        See Also:
        Configuration.getChildren()