KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > cocoon > components > SitemapConfigurationHolder


1 /*
2  * Copyright 1999-2004 The Apache Software Foundation.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package org.apache.cocoon.components;
17
18 /**
19  * A {@link SitemapConfigurable} component gets the sitemap configuration
20  * using this object.
21  *
22  * @since 2.1
23  *
24  * @author <a HREF="mailto:cziegeler@apache.org">Carsten Ziegeler</a>
25  * @version CVS $Id: SitemapConfigurationHolder.java 30932 2004-07-29 17:35:38Z vgritsenko $
26  */
27 public interface SitemapConfigurationHolder {
28
29     /**
30      * Get the configuration for the current sitemap
31      * @return The configuration
32      */
33     ChainedConfiguration getConfiguration();
34     
35     /**
36      * Get the prepared configuration for the current sitemap
37      * @return The configuration or null if no prepared is available
38      */
39     Object JavaDoc getPreparedConfiguration();
40     
41     /**
42      * Set the prepared configuration for the current sitemap.
43      * After it is set by a component, it can be get using
44      * {@link #getPreparedConfiguration()}.
45      *
46      * @param preparedConfig The prepared configuration
47      */
48     void setPreparedConfiguration(ChainedConfiguration configuration, Object JavaDoc preparedConfig);
49 }
50
Popular Tags