KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jicengine > Builder


1 package org.jicengine;
2 import org.xml.sax.SAXException JavaDoc;
3 import java.io.IOException JavaDoc;
4
5 /**
6  * <p>
7  * Builder instances read JIC files and execute the construction instructions
8  * in the files. Builder instances are obtained from the <code>JICEngine</code>
9  * class.
10  * </p>
11  *
12  * <p>
13  * Currently, you don't have to operate with Builder instances in order to
14  * process JIC files, you can use the static build-methods of the class
15  * <code>org.jicengine.JICEngine</code>. This class is needed only if there would be a need
16  * to configure the Builder instances somehow before processing. At the moment,
17  * Builders can't be configured in any way.
18  * </p>
19  *
20  *
21  * <p>
22  * Copyright (C) 2004 Timo Laitinen
23  * </p>
24  *
25  * @author Timo Laitinen
26  * @created 2004-09-20
27  * @since JICE-0.10
28  * @see org.jicengine.JICEngine
29  */
30
31 public interface Builder {
32
33     /**
34      * <p>
35      * Processes a JIC file and returns the result.
36      * </p>
37      *
38      *
39      * @param instructions instructions on how to build the application.
40      * path of the JIC file + optionally some parameters.
41      * @return the constructed object. It will be the element instance of the
42      * root JIC element. Null is returned if the root JIC element is an action
43      * element.
44      *
45      * @throws IOException if there are problems reading the JIC file.
46      * @throws SAXException if the content in the JIC file is not well-formed XML.
47      * @throws JICException in case of any other exception. Exceptions may occur
48      * because the JIC instructions are not valid or because some method call
49      * resulted in application exception.
50      */
51     public Object JavaDoc build(Instructions instructions) throws IOException JavaDoc, SAXException JavaDoc, JICException;
52
53 }
54
Popular Tags