KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > jasper > Options


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 package org.apache.jasper;
19
20 import java.io.File JavaDoc;
21 import java.util.Map JavaDoc;
22
23 import org.apache.jasper.compiler.JspConfig;
24 import org.apache.jasper.compiler.TagPluginManager;
25 import org.apache.jasper.compiler.TldLocationsCache;
26
27 /**
28  * A class to hold all init parameters specific to the JSP engine.
29  *
30  * @author Anil K. Vijendran
31  * @author Hans Bergsten
32  * @author Pierre Delisle
33  */
34 public interface Options {
35
36     /**
37      * Returns true if Jasper issues a compilation error instead of a runtime
38      * Instantiation error if the class attribute specified in useBean action
39      * is invalid.
40      */
41     public boolean getErrorOnUseBeanInvalidClassAttribute();
42
43     /**
44      * Are we keeping generated code around?
45      */
46     public boolean getKeepGenerated();
47
48     /**
49      * Returns true if tag handler pooling is enabled, false otherwise.
50      */
51     public boolean isPoolingEnabled();
52
53     /**
54      * Are we supporting HTML mapped servlets?
55      */
56     public boolean getMappedFile();
57
58     /**
59      * Should errors be sent to client or thrown into stderr?
60      */
61     public boolean getSendErrorToClient();
62  
63     /**
64      * Should we include debug information in compiled class?
65      */
66     public boolean getClassDebugInfo();
67
68     /**
69      * Background compile thread check interval in seconds
70      */
71     public int getCheckInterval();
72
73     /**
74      * Is Jasper being used in development mode?
75      */
76     public boolean getDevelopment();
77
78     /**
79      * Should we include a source fragment in exception messages, which could be displayed
80      * to the developer ?
81      */
82     public boolean getDisplaySourceFragment();
83
84     /**
85      * Is the generation of SMAP info for JSR45 debugging suppressed?
86      */
87     public boolean isSmapSuppressed();
88
89     /**
90      * Indicates whether SMAP info for JSR45 debugging should be dumped to a
91      * file.
92      * Ignored is suppressSmap() is true
93      */
94     public boolean isSmapDumped();
95
96     /**
97      * Should white spaces between directives or actions be trimmed?
98      */
99     public boolean getTrimSpaces();
100
101     /**
102      * Class ID for use in the plugin tag when the browser is IE.
103      */
104     public String JavaDoc getIeClassId();
105
106     /**
107      * What is my scratch dir?
108      */
109     public File JavaDoc getScratchDir();
110
111     /**
112      * What classpath should I use while compiling the servlets
113      * generated from JSP files?
114      */
115     public String JavaDoc getClassPath();
116
117     /**
118      * Compiler to use.
119      */
120     public String JavaDoc getCompiler();
121
122     /**
123      * The compiler target VM, e.g. 1.1, 1.2, 1.3, 1.4, or 1.5.
124      */
125     public String JavaDoc getCompilerTargetVM();
126
127     /**
128      * Compiler source VM, e.g. 1.3, 1.4, or 1.5.
129      */
130     public String JavaDoc getCompilerSourceVM();
131
132     /**
133      * Java compiler class to use.
134      */
135     public String JavaDoc getCompilerClassName();
136
137     /**
138      * The cache for the location of the TLD's
139      * for the various tag libraries 'exposed'
140      * by the web application.
141      * A tag library is 'exposed' either explicitely in
142      * web.xml or implicitely via the uri tag in the TLD
143      * of a taglib deployed in a jar file (WEB-INF/lib).
144      *
145      * @return the instance of the TldLocationsCache
146      * for the web-application.
147      */
148     public TldLocationsCache getTldLocationsCache();
149
150     /**
151      * Java platform encoding to generate the JSP
152      * page servlet.
153      */
154     public String JavaDoc getJavaEncoding();
155
156     /**
157      * boolean flag to tell Ant whether to fork JSP page compilations.
158      */
159     public boolean getFork();
160
161     /**
162      * Obtain JSP configuration informantion specified in web.xml.
163      */
164     public JspConfig getJspConfig();
165
166     /**
167      * Is generation of X-Powered-By response header enabled/disabled?
168      */
169     public boolean isXpoweredBy();
170
171     /**
172      * Obtain a Tag Plugin Manager
173      */
174     public TagPluginManager getTagPluginManager();
175
176     /**
177      * Are Text strings to be generated as char arrays?
178      */
179     public boolean genStringAsCharArray();
180     
181     /**
182      * Modification test interval.
183      */
184     public int getModificationTestInterval();
185     
186     /**
187      * Is caching enabled (used for precompilation).
188      */
189     public boolean isCaching();
190     
191     /**
192      * The web-application wide cache for the returned TreeNode
193      * by parseXMLDocument in TagLibraryInfoImpl.parseTLD,
194      * if isCaching returns true.
195      *
196      * @return the Map(String uri, TreeNode tld) instance.
197      */
198     public Map JavaDoc getCache();
199     
200 }
201
Popular Tags