org.apache.myfaces.trinidad.config.RegionManager Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of trinidad-api Show documentation

Public API for the Apache MyFaces Trinidad project

There is a newer version: 2.2.1

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.myfaces.trinidad.config;

import java.util.Map;

/**
 * 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.
 */
public abstract class RegionManager 
{
  protected RegionManager()
  {
  }
  
  /**
   * Gets all the registered regions.
   * @return An immutable Map. 
   *  Each key is a regionType String.
   *  Each value is of type {@link RegionConfig}.
   */
  public abstract Map getRegionConfigs();
  
  /**
   * Gets the RegionConfig for a particular regionType
   * @param regionType the component-type of the region 
   * @return null, if the region does not exist. 
   */
  public abstract RegionConfig getRegionConfig(String regionType);
}