org.apache.myfaces.trinidad.config

## Class RegionManager

- java.lang.Object
- - org.apache.myfaces.trinidad.config.RegionManager

-     public abstract class RegionManager
      extends Object

  Manages region definitions. This will parse the region metadata files to create and cache an instance of this object. All resources with the name "/META-INF/region-metadata.xml" will be searched. /WEB-INF/region-metadata.xml will also be searched.

- - ### Constructor Summary

    Constructors
    Modifier | Constructor and Description
    --- | ---
    `protected` | `RegionManager()`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `abstract RegionConfig` | `getRegionConfig(String regionType)` Gets the RegionConfig for a particular regionType
    `abstract Map<String,RegionConfig>` | `getRegionConfigs()` Gets all the registered regions.

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### RegionManager

          protected RegionManager()

  - ### Method Detail

    - #### getRegionConfigs

          public abstract Map<String,RegionConfig> getRegionConfigs()

      Gets all the registered regions.
      Returns:
        An immutable Map. Each key is a regionType String. Each value is of type `RegionConfig`.

    - #### getRegionConfig

          public abstract RegionConfig getRegionConfig(String regionType)

      Gets the RegionConfig for a particular regionType
      Parameters:
        `regionType` - the component-type of the region
      Returns:
        null, if the region does not exist.

Copyright © 2001-2017 The Apache Software Foundation. All Rights Reserved.