1 package org.apache.velocity.runtime; 2 3 /* 4 * Licensed to the Apache Software Foundation (ASF) under one 5 * or more contributor license agreements. See the NOTICE file 6 * distributed with this work for additional information 7 * regarding copyright ownership. The ASF licenses this file 8 * to you under the Apache License, Version 2.0 (the 9 * "License"); you may not use this file except in compliance 10 * with the License. You may obtain a copy of the License at 11 * 12 * http://www.apache.org/licenses/LICENSE-2.0 13 * 14 * Unless required by applicable law or agreed to in writing, 15 * software distributed under the License is distributed on an 16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 17 * KIND, either express or implied. See the License for the 18 * specific language governing permissions and limitations 19 * under the License. 20 */ 21 22 /** 23 * This class gathers deprecated runtime constants 24 * 25 * @author <a href="mailto:claude@renegat.net">Claude Brisson</a> 26 * @version $$ 27 */ 28 29 @Deprecated 30 public interface DeprecatedRuntimeConstants 31 { 32 /** 33 * Logging of invalid references. 34 * @deprecated see {@link RuntimeConstants#RUNTIME_LOG_REFERENCE_LOG_INVALID} 35 */ 36 String OLD_RUNTIME_LOG_REFERENCE_LOG_INVALID = "runtime.log.invalid.references"; 37 38 /** 39 * Maximum allowed number of loops. 40 * @deprecated see {@link RuntimeConstants#MAX_NUMBER_LOOPS} 41 */ 42 String OLD_MAX_NUMBER_LOOPS = "directive.foreach.maxloops"; 43 44 /** 45 * Whether to throw an exception or just skip bad iterables. Default is true. 46 * @since 1.6 47 * @deprecated see {@link RuntimeConstants#SKIP_INVALID_ITERATOR} 48 */ 49 String OLD_SKIP_INVALID_ITERATOR = "directive.foreach.skip.invalid"; 50 51 /** 52 * An empty object (string, collection) or zero number is false. 53 * @since 2.0 54 * @deprecated see {@link RuntimeConstants#CHECK_EMPTY_OBJECTS} 55 */ 56 String OLD_CHECK_EMPTY_OBJECTS = "directive.if.emptycheck"; 57 58 /** 59 * Starting tag for error messages triggered by passing a parameter not allowed in the #include directive. Only string literals, 60 * and references are allowed. 61 * @deprecated see {@link RuntimeConstants#ERRORMSG_START} 62 */ 63 String OLD_ERRORMSG_START = "directive.include.output.errormsg.start"; 64 65 /** 66 * Ending tag for error messages triggered by passing a parameter not allowed in the #include directive. Only string literals, 67 * and references are allowed. 68 * @deprecated see {@link RuntimeConstants#ERRORMSG_END} 69 */ 70 String OLD_ERRORMSG_END = "directive.include.output.errormsg.end"; 71 72 /** 73 * Maximum recursion depth allowed for the #parse directive. 74 * @deprecated see {@link RuntimeConstants#PARSE_DIRECTIVE_MAXDEPTH} 75 */ 76 String OLD_PARSE_DIRECTIVE_MAXDEPTH = "directive.parse.max.depth"; 77 78 /** 79 * Maximum recursion depth allowed for the #define directive. 80 * @deprecated see {@link RuntimeConstants#DEFINE_DIRECTIVE_MAXDEPTH} 81 */ 82 String OLD_DEFINE_DIRECTIVE_MAXDEPTH = "directive.define.max.depth"; 83 84 /** 85 * Vector of custom directives 86 * @deprecated see {@link RuntimeConstants#CUSTOM_DIRECTIVES} 87 */ 88 String OLD_CUSTOM_DIRECTIVES = "userdirective"; 89 90 /** 91 * The <code>resource.manager.cache.size</code> property specifies the cache upper bound (if relevant). 92 * @deprecated see {@link RuntimeConstants#RESOURCE_MANAGER_DEFAULTCACHE_SIZE} 93 */ 94 String OLD_RESOURCE_MANAGER_DEFAULTCACHE_SIZE = "resource.manager.defaultcache.size"; 95 96 /** 97 * controls if the finding of a resource is logged. 98 * @deprecated see {@link RuntimeConstants#RESOURCE_MANAGER_LOGWHENFOUND} 99 */ 100 String OLD_RESOURCE_MANAGER_LOGWHENFOUND = "resource.manager.logwhenfound"; 101 102 /** 103 * Key used to retrieve the names of the resource loaders to be used. In a properties file they may appear as the following: 104 * <p>resource.loader = file,classpath</p> 105 * @deprecated see {@link RuntimeConstants#RESOURCE_LOADERS} 106 */ 107 String OLD_RESOURCE_LOADERS = "resource.loader"; 108 109 /** 110 * The public handle for setting a path in the FileResourceLoader. 111 * @deprecated see {@link RuntimeConstants#FILE_RESOURCE_LOADER_PATH} 112 */ 113 String OLD_FILE_RESOURCE_LOADER_PATH = "file.resource.loader.path"; 114 115 /** 116 * The public handle for turning the caching on in the FileResourceLoader. 117 * @deprecated see {@link RuntimeConstants#FILE_RESOURCE_LOADER_CACHE} 118 */ 119 String OLD_FILE_RESOURCE_LOADER_CACHE = "file.resource.loader.cache"; 120 121 /** 122 * Resource loader modification check interval property suffix 123 */ 124 String OLD_RESOURCE_LOADER_CHECK_INTERVAL = "modificationCheckInterval"; 125 126 /** 127 * Datasource loader datasource url 128 * @deprecated see {@link RuntimeConstants#DS_RESOURCE_LOADER_DATASOURCE} 129 */ 130 String OLD_DS_RESOURCE_LOADER_DATASOURCE = "ds.resource.loader.resource.datasource"; 131 132 /** 133 * Datasource loader template key column 134 * @deprecated see {@link RuntimeConstants#DS_RESOURCE_LOADER_KEY_COLUMN} 135 */ 136 String OLD_DS_RESOURCE_LOADER_KEY_COLUMN = "ds.resource.loader.resource.keycolumn"; 137 138 /** 139 * Datasource loader template content column 140 * @deprecated see {@link RuntimeConstants#DS_RESOURCE_LOADER_TEMPLATE_COLUMN} 141 */ 142 String OLD_DS_RESOURCE_LOADER_TEMPLATE_COLUMN = "ds.resource.loader.resource.templatecolumn"; 143 144 /** 145 * Datasource loader template timestamp column 146 * @deprecated see {@link RuntimeConstants#DS_RESOURCE_LOADER_TIMESTAMP_COLUMN} 147 */ 148 String OLD_DS_RESOURCE_LOADER_TIMESTAMP_COLUMN = "ds.resource.loader.resource.timestampcolumn"; 149 150 /** 151 * The default character encoding for the templates. Used by the parser in processing the input streams. 152 * @deprecated see {@link RuntimeConstants#INPUT_ENCODING} 153 */ 154 String OLD_INPUT_ENCODING = "input.encoding"; 155 156 /** 157 * The <code>eventhandler.referenceinsertion.class</code> property specifies a list of the 158 * {@link org.apache.velocity.app.event.ReferenceInsertionEventHandler} implementations to use. 159 * @deprecated see {@link RuntimeConstants#EVENTHANDLER_REFERENCEINSERTION} 160 */ 161 String OLD_EVENTHANDLER_REFERENCEINSERTION = "eventhandler.referenceinsertion.class"; 162 163 /** 164 * The <code>eventhandler.methodexception.class</code> property specifies a list of the 165 * {@link org.apache.velocity.app.event.MethodExceptionEventHandler} implementations to use. 166 * @deprecated see {@link RuntimeConstants#EVENTHANDLER_METHODEXCEPTION} 167 */ 168 String OLD_EVENTHANDLER_METHODEXCEPTION = "eventhandler.methodexception.class"; 169 170 /** 171 * The <code>eventhandler.include.class</code> property specifies a list of the 172 * {@link org.apache.velocity.app.event.IncludeEventHandler} implementations to use. 173 * @deprecated see {@link RuntimeConstants#EVENTHANDLER_INCLUDE} 174 */ 175 String OLD_EVENTHANDLER_INCLUDE = "eventhandler.include.class"; 176 177 /** 178 * The <code>eventhandler.invalidreferences.class</code> property specifies a list of the 179 * {@link org.apache.velocity.app.event.InvalidReferenceEventHandler} implementations to use. 180 * @deprecated see {@link RuntimeConstants#EVENTHANDLER_INVALIDREFERENCES} 181 */ 182 String OLD_EVENTHANDLER_INVALIDREFERENCES = "eventhandler.invalidreferences.class"; 183 184 /** 185 * Name of local Velocimacro library template. 186 * @deprecated see {@link RuntimeConstants#VM_LIBRARY} 187 */ 188 String OLD_VM_LIBRARY = "velocimacro.library"; 189 190 /** 191 * Default Velocimacro library template. 192 * @deprecated see {@link RuntimeConstants#VM_LIBRARY_DEFAULT} 193 */ 194 String OLD_VM_LIBRARY_DEFAULT = "VM_global_library.vm"; 195 196 /** 197 * boolean (true/false) default true: allow inline (in-template) macro definitions. 198 * @deprecated see {@link RuntimeConstants#VM_PERM_ALLOW_INLINE} 199 */ 200 String OLD_VM_PERM_ALLOW_INLINE = "velocimacro.permissions.allow.inline"; 201 202 /** 203 * boolean (true/false) default false: allow inline (in-template) macro definitions to replace existing. 204 * @deprecated see {@link RuntimeConstants#VM_PERM_ALLOW_INLINE_REPLACE_GLOBAL} 205 */ 206 String OLD_VM_PERM_ALLOW_INLINE_REPLACE_GLOBAL = "velocimacro.permissions.allow.inline.to.replace.global"; 207 208 /** 209 * Switch for forcing inline macros to be local: default false. 210 * @deprecated see {@link RuntimeConstants#VM_PERM_INLINE_LOCAL} 211 */ 212 String OLD_VM_PERM_INLINE_LOCAL = "velocimacro.permissions.allow.inline.local.scope"; 213 214 /** 215 * Specify the maximum depth for macro calls 216 * @since 1.6 217 * @deprecated see {@link RuntimeConstants#VM_MAX_DEPTH} 218 */ 219 String OLD_VM_MAX_DEPTH = "velocimacro.max.depth"; 220 221 /** 222 * Defines name of the reference that can be used to get the AST block passed to block macro calls. 223 * @since 1.7 224 * @deprecated see {@link RuntimeConstants#VM_BODY_REFERENCE} 225 */ 226 String OLD_VM_BODY_REFERENCE = "velocimacro.body.reference"; 227 228 /** 229 * Properties referenced in the template are required to exist the object 230 * @deprecated see {@link RuntimeConstants#RUNTIME_REFERENCES_STRICT} 231 */ 232 String OLD_RUNTIME_REFERENCES_STRICT = "runtime.references.strict"; 233 234 /** 235 * Indicates we are going to use modified escape behavior in strict mode 236 * @deprecated see {@link RuntimeConstants#RUNTIME_REFERENCES_STRICT_ESCAPE} 237 */ 238 String OLD_RUNTIME_REFERENCES_STRICT_ESCAPE = "runtime.references.strict.escape"; 239 240 /** 241 * key name for uberspector. Multiple classnames can be specified,in which case uberspectors will be chained. 242 * @deprecated see {@link RuntimeConstants#UBERSPECT_CLASSNAME} 243 */ 244 String OLD_UBERSPECT_CLASSNAME = "runtime.introspector.uberspect"; 245 246 /** 247 * key for Conversion Manager class 248 * @deprecated see {@link RuntimeConstants#CONVERSION_HANDLER_INSTANCE} 249 */ 250 String OLD_CONVERSION_HANDLER_CLASS = "introspector.conversion_handler.class"; 251 252 /** 253 * Switch for the interpolation facility for string literals. 254 * @deprecated see {@link RuntimeConstants#INTERPOLATE_STRINGLITERALS} 255 */ 256 String OLD_INTERPOLATE_STRINGLITERALS = "runtime.interpolate.string.literals"; 257 258 /** 259 * Switch for ignoring nulls in math equations vs throwing exceptions. 260 * @deprecated see {@link RuntimeConstants#STRICT_MATH} 261 */ 262 String OLD_STRICT_MATH = "runtime.strict.math"; 263 264 /** 265 * Key upon which a context should be accessible within itself 266 * @deprecated see {@link RuntimeConstants#CONTEXT_AUTOREFERENCE_KEY} 267 */ 268 String OLD_CONTEXT_AUTOREFERENCE_KEY = "context.autoreference.key"; 269 270 /** 271 * Space gobbling mode 272 * @since 2.0 273 * @deprecated see {@link RuntimeConstants#SPACE_GOBBLING} 274 */ 275 String OLD_SPACE_GOBBLING = "space.gobbling"; 276 277 /** 278 * When displaying null or invalid non-quiet references, use the argument literal reference 279 * instead of the one in the macro block. Defaults to false. 280 * @since 2.1 281 * @Deprecated since 2.2, see {@link RuntimeConstants#VM_ENABLE_BC_MODE} 282 **/ 283 String OLD_VM_ENABLE_BC_MODE = "velocimacro.arguments.preserve_literals"; 284 285 } 286