Class CmsElementWithSubElementsParamConfigHelper

    • Constructor Summary

      Constructors 
      Constructor Description
      CmsElementWithSubElementsParamConfigHelper​(java.lang.String parentPath, java.lang.String name, java.lang.Class<?> cls, java.lang.String... subElements)
      Creates a new instance.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addRules​(org.apache.commons.digester3.Digester digester)
      Adds the configuration parsing rules to the digester.
      void generateXml​(org.dom4j.Element parent, I_CmsConfigurationParameterHandler config)
      Generates the XML configuration from the given configuration object.
      java.lang.String getBasePath()
      Gets the xPath of the configuration element.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • CmsElementWithSubElementsParamConfigHelper

        public CmsElementWithSubElementsParamConfigHelper​(java.lang.String parentPath,
                                                          java.lang.String name,
                                                          java.lang.Class<?> cls,
                                                          java.lang.String... subElements)
        Creates a new instance.

        Parameters:
        parentPath - the parent XPath
        name - the XML element name
        cls - the class to use for the configuration (must be subclass of I_CmsConfigurationParameterHandler)
        subElements - the attributes to read / write
    • Method Detail

      • addRules

        public void addRules​(org.apache.commons.digester3.Digester digester)
        Adds the configuration parsing rules to the digester.

        Parameters:
        digester - the digester to which the rules should be added
      • generateXml

        public void generateXml​(org.dom4j.Element parent,
                                I_CmsConfigurationParameterHandler config)
        Generates the XML configuration from the given configuration object.

        Parameters:
        parent - the parent element
        config - the configuration
      • getBasePath

        public java.lang.String getBasePath()
        Gets the xPath of the configuration element.

        Returns:
        the xPath of the configuration element