Package org.opencms.ade.containerpage.inherited

Class CmsContainerConfigurationGroup

  • public class CmsContainerConfigurationGroup
extends java.lang.Object
    A class which represents all the configuration entries which have been read from an inherited container configuration file.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      CmsContainerConfiguration getConfiguration​(java.lang.String name)
      Gets the configuration for a given name and locale.
      java.lang.String getRootPath()
      Gets the root path of the file from which this configuration was read.
      CmsUUID getStructureId()
      Gets the structure id of the file from which this configuration was read.
      void setResource​(CmsResource configResource)
      Initializes the information about the resource from which this configuration was read.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • CmsContainerConfigurationGroup

        public CmsContainerConfigurationGroup​(java.util.Map<java.util.Locale,​java.util.Map<java.lang.String,​CmsContainerConfiguration>> configurations)
        Creates a new instance.

        Parameters:
        configurations - the data contained by this configuration group

    • Method Detail

      • getConfiguration

        public CmsContainerConfiguration getConfiguration​(java.lang.String name)
        Gets the configuration for a given name and locale.

        Parameters:
        name - the configuration name
        Returns:
        the configuration for the name and locale

      • getRootPath

        public java.lang.String getRootPath()
        Gets the root path of the file from which this configuration was read.

        Returns:
        the root path of the configuration resource

      • getStructureId

        public CmsUUID getStructureId()
        Gets the structure id of the file from which this configuration was read.

        Returns:
        the structure id of the configuration file

      • setResource

        public void setResource​(CmsResource configResource)
        Initializes the information about the resource from which this configuration was read.

        Parameters:
        configResource - the configuration file