View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.myfaces.trinidad.config;
20  
21  import java.util.Map;
22  
23  /**
24   * Manages region definitions.
25   * This will parse the region metadata files to create and cache 
26   * an instance of this object.
27   * All resources with the name "/META-INF/region-metadata.xml" will be searched.
28   * /WEB-INF/region-metadata.xml will also be searched.
29   */
30  public abstract class RegionManager 
31  {
32    protected RegionManager()
33    {
34    }
35    
36    /**
37     * Gets all the registered regions.
38     * @return An immutable Map. 
39     *  Each key is a regionType String.
40     *  Each value is of type {@link RegionConfig}.
41     */
42    public abstract Map<String, RegionConfig> getRegionConfigs();
43    
44    /**
45     * Gets the RegionConfig for a particular regionType
46     * @param regionType the component-type of the region 
47     * @return null, if the region does not exist. 
48     */
49    public abstract RegionConfig getRegionConfig(String regionType);
50  }