2009/05/20 - Apache Shale has been retired.

For more information, please explore the Attic.

Coverage Report - org.apache.shale.clay.config.ClayConfigParser

Classes in this File

 /*
  * 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.
  */
 
 /*
  * $Id: ClayConfigParser.java 464373 2006-10-16 04:21:54Z rahul $
  */
 package org.apache.shale.clay.config;
 
 import java.io.IOException;
 import java.net.URL;
 
 import org.apache.shale.clay.config.beans.ConfigBean;
 import org.xml.sax.SAXException;
 
 /**
  * <p>This interfaces is used by a {@link ConfigBean} instance to load
  * a configuration file.  These files come in two flavors XML and HTML.
  * The {@link org.apache.shale.clay.config.beans.ComponentConfigBean}
  * handles materializing XML documents into a graph of
  * {@link org.apache.shale.clay.config.beans.ComponentBean} and the
  * {@link org.apache.shale.clay.config.beans.TemplateConfigBean}
  * loads an HTML template into {@link org.apache.shale.clay.config.beans.ComponentBean}
  * object representations.
  * </p>
  */
 public interface ClayConfigParser {
 
     /**
      * <p>Sets an instance of the {@link ConfigBean} that pools a
      * collection of faces meta-component definitions.
      * </p>
      *
      * @param config bean pool
      */
     void setConfig(ConfigBean config);
 
     /**
      * <p>Returns an instance of the {@link ConfigBean} that pools a
      * collection of faces meta-component definitions.
      * </p>
      *
      * @return bean pool
      */
     ConfigBean getConfig();
 
     /**
      * <p>Loads the <code>url</code> identified by the <code>watchDogName</code>
      * into the {@link ConfigBean} object pool.</p>
      *
      * @param url file to load
      * @param watchDogName dependency watch group for the url file
      * @exception IOException file load
      * @exception SAXException xml parser
      */
     void loadConfigFile(URL url, String watchDogName)
            throws IOException, SAXException;
 }

1		/*
2		* Licensed to the Apache Software Foundation (ASF) under one or more
3		* contributor license agreements. See the NOTICE file distributed with
4		* this work for additional information regarding copyright ownership.
5		* The ASF licenses this file to you under the Apache License, Version 2.0
6		* (the "License"); you may not use this file except in compliance with
7		* the License. You may obtain a copy of the License at
8		*
9		* http://www.apache.org/licenses/LICENSE-2.0
10		*
11		* Unless required by applicable law or agreed to in writing, software
12		* distributed under the License is distributed on an "AS IS" BASIS,
13		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14		* See the License for the specific language governing permissions and
15		* limitations under the License.
16		*/
17
18		/*
19		* $Id: ClayConfigParser.java 464373 2006-10-16 04:21:54Z rahul $
20		*/
21		package org.apache.shale.clay.config;
22
23		import java.io.IOException;
24		import java.net.URL;
25
26		import org.apache.shale.clay.config.beans.ConfigBean;
27		import org.xml.sax.SAXException;
28
29		/**
30		* <p>This interfaces is used by a {@link ConfigBean} instance to load
31		* a configuration file. These files come in two flavors XML and HTML.
32		* The {@link org.apache.shale.clay.config.beans.ComponentConfigBean}
33		* handles materializing XML documents into a graph of
34		* {@link org.apache.shale.clay.config.beans.ComponentBean} and the
35		* {@link org.apache.shale.clay.config.beans.TemplateConfigBean}
36		* loads an HTML template into {@link org.apache.shale.clay.config.beans.ComponentBean}
37		* object representations.
38		* </p>
39		*/
40		public interface ClayConfigParser {
41
42		/**
43		* <p>Sets an instance of the {@link ConfigBean} that pools a
44		* collection of faces meta-component definitions.
45		* </p>
46		*
47		* @param config bean pool
48		*/
49		void setConfig(ConfigBean config);
50
51		/**
52		* <p>Returns an instance of the {@link ConfigBean} that pools a
53		* collection of faces meta-component definitions.
54		* </p>
55		*
56		* @return bean pool
57		*/
58		ConfigBean getConfig();
59
60		/**
61		* <p>Loads the <code>url</code> identified by the <code>watchDogName</code>
62		* into the {@link ConfigBean} object pool.</p>
63		*
64		* @param url file to load
65		* @param watchDogName dependency watch group for the url file
66		* @exception IOException file load
67		* @exception SAXException xml parser
68		*/
69		void loadConfigFile(URL url, String watchDogName)
70		throws IOException, SAXException;
71		}