Configurable.java

Index Score
freemarker.core
FreeMarker

View: Reasons, Metrics, Source Code

These are the metrics that contribute to the Enerjy Score for this file, ranked by impact. So the metrics listed at the top influence the score to a greater extent that the metrics listed at the bottom.

MetricDescription
SIZESize of the file in bytes
JAVA0108JAVA0108 Incorrect javadoc: no @param tag for 'parameter'
DOC_COMMENTNumber of javadoc comment lines
JAVA0110JAVA0110 Incorrect javadoc: no @return tag
COMMENTSComment lines
DECL_COMMENTSComments in declarations
JAVA0034JAVA0034 Missing braces in if statement
CYCLOMATICCyclomatic complexity
EXITSProcedure exits
FUNCTIONSNumber of function declarations
COMPARISONSNumber of comparison operators
BLOCKSNumber of blocks
RETURNSNumber of return points from functions
JAVA0116JAVA0116 Missing javadoc: field 'field'
INTERFACE_COMPLEXITYInterface complexity
LINESNumber of lines in the source file
JAVA0117JAVA0117 Missing javadoc: method 'method'
OPERATORSNumber of operators
PROGRAM_LENGTHHalstead program length
ELOCEffective lines of code
UNIQUE_OPERANDSNumber of unique operands
PROGRAM_VOCABHalstead program vocabulary
LOGICAL_LINESNumber of statements
LOCLines of code
OPERANDSNumber of operands
PARAMSNumber of formal parameter declarations
JAVA0010JAVA0010 Non-instantiable class does not contain a non-private static member
UNIQUE_OPERATORSNumber of unique operators
JAVA0144JAVA0144 Line exceeds maximum M characters
PROGRAM_VOLUMEHalstead program volume
JAVA0136JAVA0136 N methods defined in class (maximum: M)
JAVA0126JAVA0126 Method declares unchecked exception in throws
JAVA0173JAVA0173 Unused method parameter
EXEC_COMMENTSComments in executable code
JAVA0100JAVA0100 Class contains N non-final fields (maximum: M)
LINE_COMMENTNumber of line comments
LOOPSNumber of loops
JAVA0254JAVA0254 Use enhanced for loop construct instead of Iterator
NEST_DEPTHMaximum nesting depth
JAVA0145JAVA0145 Tab character used in source file
/* * Copyright (c) 2003 The Visigoth Software Society. All rights * reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in * the documentation and/or other materials provided with the * distribution. * * 3. The end-user documentation included with the redistribution, if * any, must include the following acknowledgement: * "This product includes software developed by the * Visigoth Software Society (http://www.visigoths.org/)." * Alternately, this acknowledgement may appear in the software itself, * if and wherever such third-party acknowledgements normally appear. * * 4. Neither the name "FreeMarker", "Visigoth", nor any of the names of the * project contributors may be used to endorse or promote products derived * from this software without prior written permission. For written * permission, please contact visigoths@visigoths.org. * * 5. Products derived from this software may not be called "FreeMarker" or "Visigoth" * nor may "FreeMarker" or "Visigoth" appear in their names * without prior written permission of the Visigoth Software Society. * * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL THE VISIGOTH SOFTWARE SOCIETY OR * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Visigoth Software Society. For more * information on the Visigoth Software Society, please see * http://www.visigoths.org/ */ package freemarker.core; import java.io.IOException; import java.io.InputStream; import java.util.*; import freemarker.template.*; import freemarker.template.utility.ClassUtil; import freemarker.template.utility.StringUtil; import freemarker.core.ast.ArithmeticEngine; import freemarker.ext.beans.BeansWrapper; /** * This is a common superclass of {@link freemarker.template.Configuration}, * {@link freemarker.template.Template}, and {@link Environment} classes. * It provides settings that are common to each of them. FreeMarker * uses a three-level setting hierarchy - the return value of every setting * getter method on <code>Configurable</code> objects inherits its value from its parent * <code>Configurable</code> object, unless explicitly overridden by a call to a * corresponding setter method on the object itself. The parent of an * <code>Environment</code> object is a <code>Template</code> object, the * parent of a <code>Template</code> object is a <code>Configuration</code> * object. * * @version $Id: Configurable.java,v 1.24 2006/02/03 19:22:03 revusky Exp $ * @author Attila Szegedi */ public class Configurable { public static final String LOCALE_KEY = "locale"; public static final String NUMBER_FORMAT_KEY = "number_format"; public static final String TIME_FORMAT_KEY = "time_format"; public static final String DATE_FORMAT_KEY = "date_format"; public static final String DATETIME_FORMAT_KEY = "datetime_format"; public static final String TIME_ZONE_KEY = "time_zone"; public static final String TEMPLATE_EXCEPTION_HANDLER_KEY = "template_exception_handler"; public static final String ARITHMETIC_ENGINE_KEY = "arithmetic_engine"; public static final String OBJECT_WRAPPER_KEY = "object_wrapper"; public static final String BOOLEAN_FORMAT_KEY = "boolean_format"; public static final String OUTPUT_ENCODING_KEY = "output_encoding"; public static final String URL_ESCAPING_CHARSET_KEY = "url_escaping_charset"; public static final String STRICT_BEAN_MODELS = "strict_bean_models"; private static final char COMMA = ','; private Configurable parent; private Properties properties; private HashMap<Object, Object> customAttributes; private Locale locale; private String numberFormat; private String timeFormat; private String dateFormat; private String dateTimeFormat; private TimeZone timeZone; private String trueFormat; private String falseFormat; private TemplateExceptionHandler templateExceptionHandler; private ArithmeticEngine arithmeticEngine; private ObjectWrapper objectWrapper; private String outputEncoding; private boolean outputEncodingSet; private String urlEscapingCharset; private boolean urlEscapingCharsetSet; public Configurable() { parent = null; locale = Locale.getDefault(); timeZone = TimeZone.getDefault(); numberFormat = "number"; timeFormat = ""; dateFormat = ""; dateTimeFormat = ""; trueFormat = "true"; falseFormat = "false"; templateExceptionHandler = TemplateExceptionHandler.DEBUG_HANDLER; arithmeticEngine = ArithmeticEngine.BIGDECIMAL_ENGINE; objectWrapper = new DefaultObjectWrapper(); // outputEncoding and urlEscapingCharset defaults to null, // which means "not specified" properties = new Properties(); properties.setProperty(LOCALE_KEY, locale.toString()); properties.setProperty(TIME_FORMAT_KEY, timeFormat); properties.setProperty(DATE_FORMAT_KEY, dateFormat); properties.setProperty(DATETIME_FORMAT_KEY, dateTimeFormat); properties.setProperty(TIME_ZONE_KEY, timeZone.getID()); properties.setProperty(NUMBER_FORMAT_KEY, numberFormat); properties.setProperty(TEMPLATE_EXCEPTION_HANDLER_KEY, templateExceptionHandler.getClass().getName()); properties.setProperty(ARITHMETIC_ENGINE_KEY, arithmeticEngine.getClass().getName()); properties.setProperty(BOOLEAN_FORMAT_KEY, "true,false"); // as outputEncoding and urlEscapingCharset defaults to null, // they are not set customAttributes = new HashMap<Object, Object>(); } /** * Creates a new instance. Normally you do not need to use this constructor, * as you don't use <code>Configurable</code> directly, but its subclasses. */ public Configurable(Configurable parent) { this.parent = parent; locale = null; numberFormat = null; trueFormat = null; falseFormat = null; templateExceptionHandler = null; properties = new Properties(parent.properties); customAttributes = new HashMap<Object, Object>(); } protected Object clone() throws CloneNotSupportedException { Configurable copy = (Configurable)super.clone(); copy.properties = new Properties(properties); copy.customAttributes = new HashMap<Object,Object>(customAttributes); return copy; } /** * Returns the parent <tt>Configurable</tt> object of this object. * The parent stores the default values for this configurable. For example, * the parent of the {@link freemarker.template.Template} object is the * {@link freemarker.template.Configuration} object, so setting values not * specfied on template level are specified by the confuration object. * * @return the parent <tt>Configurable</tt> object, or null, if this is * the root <tt>Configurable</tt> object. */ public final Configurable getParent() { return parent; } /** * Reparenting support. This is used by Environment when it includes a * template - the included template becomes the parent configurable during * its evaluation. */ public void setParent(Configurable parent) { this.parent = parent; } /** * Sets the locale to assume when searching for template files with no * explicit requested locale. */ public void setLocale(Locale locale) { if (locale == null) throw new IllegalArgumentException("Setting \"locale\" can't be null"); this.locale = locale; properties.setProperty(LOCALE_KEY, locale.toString()); } /** * Returns the time zone to use when formatting time values. Defaults to * system time zone. */ public TimeZone getTimeZone() { return timeZone != null ? timeZone : parent.getTimeZone(); } /** * Sets the time zone to use when formatting time values. */ public void setTimeZone(TimeZone timeZone) { if (timeZone == null) throw new IllegalArgumentException("Setting \"time_zone\" can't be null"); this.timeZone = timeZone; properties.setProperty(TIME_ZONE_KEY, timeZone.getID()); } /** * Returns the assumed locale when searching for template files with no * explicit requested locale. Defaults to system locale. */ public Locale getLocale() { return locale != null ? locale : parent.getLocale(); } /** * Sets the number format used to convert numbers to strings. */ public void setNumberFormat(String numberFormat) { if (numberFormat == null) throw new IllegalArgumentException("Setting \"number_format\" can't be null"); this.numberFormat = numberFormat; properties.setProperty(NUMBER_FORMAT_KEY, numberFormat); } /** * Returns the default number format used to convert numbers to strings. * Defaults to <tt>"number"</tt> */ public String getNumberFormat() { return numberFormat != null ? numberFormat : parent.getNumberFormat(); } public void setBooleanFormat(String booleanFormat) { if (booleanFormat == null) { throw new IllegalArgumentException("Setting \"boolean_format\" can't be null"); } int comma = booleanFormat.indexOf(COMMA); if(comma == -1) { throw new IllegalArgumentException("Setting \"boolean_format\" must consist of two comma-separated values for true and false respectively"); } trueFormat = booleanFormat.substring(0, comma); falseFormat = booleanFormat.substring(comma + 1); properties.setProperty(BOOLEAN_FORMAT_KEY, booleanFormat); } public String getBooleanFormat() { if(trueFormat == null) { return parent.getBooleanFormat(); } return trueFormat + COMMA + falseFormat; } public String getBooleanFormat(boolean value) { return value ? getTrueFormat() : getFalseFormat(); } private String getTrueFormat() { return trueFormat != null ? trueFormat : parent.getTrueFormat(); } private String getFalseFormat() { return falseFormat != null ? falseFormat : parent.getFalseFormat(); } /** * Sets the date format used to convert date models representing time-only * values to strings. */ public void setTimeFormat(String timeFormat) { if (timeFormat == null) throw new IllegalArgumentException("Setting \"time_format\" can't be null"); this.timeFormat = timeFormat; properties.setProperty(TIME_FORMAT_KEY, timeFormat); } /** * Returns the date format used to convert date models representing * time-only dates to strings. * Defaults to <tt>"time"</tt> */ public String getTimeFormat() { return timeFormat != null ? timeFormat : parent.getTimeFormat(); } /** * Sets the date format used to convert date models representing date-only * dates to strings. */ public void setDateFormat(String dateFormat) { if (dateFormat == null) throw new IllegalArgumentException("Setting \"date_format\" can't be null"); this.dateFormat = dateFormat; properties.setProperty(DATE_FORMAT_KEY, dateFormat); } /** * Returns the date format used to convert date models representing * date-only dates to strings. * Defaults to <tt>"date"</tt> */ public String getDateFormat() { return dateFormat != null ? dateFormat : parent.getDateFormat(); } /** * Sets the date format used to convert date models representing datetime * dates to strings. */ public void setDateTimeFormat(String dateTimeFormat) { if (dateTimeFormat == null) throw new IllegalArgumentException("Setting \"datetime_format\" can't be null"); this.dateTimeFormat = dateTimeFormat; properties.setProperty(DATETIME_FORMAT_KEY, dateTimeFormat); } /** * Returns the date format used to convert date models representing datetime * dates to strings. * Defaults to <tt>"datetime"</tt> */ public String getDateTimeFormat() { return dateTimeFormat != null ? dateTimeFormat : parent.getDateTimeFormat(); } /** * Sets the exception handler used to handle template exceptions. * * @param templateExceptionHandler the template exception handler to use for * handling {@link TemplateException}s. By default, * {@link TemplateExceptionHandler#HTML_DEBUG_HANDLER} is used. */ public void setTemplateExceptionHandler(TemplateExceptionHandler templateExceptionHandler) { if (templateExceptionHandler == null) throw new IllegalArgumentException("Setting \"template_exception_handler\" can't be null"); this.templateExceptionHandler = templateExceptionHandler; properties.setProperty(TEMPLATE_EXCEPTION_HANDLER_KEY, templateExceptionHandler.getClass().getName()); } /** * Retrieves the exception handler used to handle template exceptions. */ public TemplateExceptionHandler getTemplateExceptionHandler() { return templateExceptionHandler != null ? templateExceptionHandler : parent.getTemplateExceptionHandler(); } /** * Sets the arithmetic engine used to perform arithmetic operations. * * @param arithmeticEngine the arithmetic engine used to perform arithmetic * operations.By default, {@link ArithmeticEngine#BIGDECIMAL_ENGINE} is * used. */ public void setArithmeticEngine(ArithmeticEngine arithmeticEngine) { if (arithmeticEngine == null) throw new IllegalArgumentException("Setting \"arithmetic_engine\" can't be null"); this.arithmeticEngine = arithmeticEngine; properties.setProperty(ARITHMETIC_ENGINE_KEY, arithmeticEngine.getClass().getName()); } /** * Retrieves the arithmetic engine used to perform arithmetic operations. */ public ArithmeticEngine getArithmeticEngine() { return arithmeticEngine != null ? arithmeticEngine : parent.getArithmeticEngine(); } /** * Sets the object wrapper used to wrap objects to template models. * * @param objectWrapper the object wrapper used to wrap objects to template * models. */ public void setObjectWrapper(ObjectWrapper objectWrapper) { if (objectWrapper == null) throw new IllegalArgumentException("Setting \"object_wrapper\" can't be null"); this.objectWrapper = objectWrapper; properties.setProperty(OBJECT_WRAPPER_KEY, objectWrapper.getClass().getName()); } /** * Retrieves the object wrapper used to wrap objects to template models. */ public ObjectWrapper getObjectWrapper() { return objectWrapper != null ? objectWrapper : parent.getObjectWrapper(); } /** * Sets the output encoding. Allows <code>null</code>, which means that the * output encoding is not known. */ public void setOutputEncoding(String outputEncoding) { this.outputEncoding = outputEncoding; // java.util.Properties doesn't allow null value! if (outputEncoding != null) { properties.setProperty(OUTPUT_ENCODING_KEY, outputEncoding); } else { properties.remove(OUTPUT_ENCODING_KEY); } outputEncodingSet = true; } public void setNumbersForComputers(boolean b) { } public String getOutputEncoding() { return outputEncodingSet ? outputEncoding : (parent != null ? parent.getOutputEncoding() : null); } /** * Sets the URL escaping charset. Allows <code>null</code>, which means that the * output encoding will be used for URL escaping. */ public void setURLEscapingCharset(String urlEscapingCharset) { this.urlEscapingCharset = urlEscapingCharset; // java.util.Properties doesn't allow null value! if (urlEscapingCharset != null) { properties.setProperty(URL_ESCAPING_CHARSET_KEY, urlEscapingCharset); } else { properties.remove(URL_ESCAPING_CHARSET_KEY); } urlEscapingCharsetSet = true; } public String getURLEscapingCharset() { return urlEscapingCharsetSet ? urlEscapingCharset : (parent != null ? parent.getURLEscapingCharset() : null); } /** * Sets a setting by a name and string value. * * <p>List of supported names and their valid values: * <ul> * <li><code>"locale"</code>: local codes with the usual format, such as <code>"en_US"</code>. * <li><code>"template_exception_handler"</code>: If the value contains dot, then it is * interpreted as class name, and the object will be created with * its parameterless constructor. If the value does not contain dot, * then it must be one of these special values: * <code>"rethrow"</code>, <code>"debug"</code>, * <code>"html_debug"</code>, <code>"ignore"</code> (case insensitive). * <li><code>"arithmetic_engine"</code>: If the value contains dot, then it is * interpreted as class name, and the object will be created with * its parameterless constructor. If the value does not contain dot, * then it must be one of these special values: * <code>"bigdecimal"</code>, <code>"conservative"</code> (case insensitive). * <li><code>"object_wrapper"</code>: If the value contains dot, then it is * interpreted as class name, and the object will be created with * its parameterless constructor. If the value does not contain dot, * then it must be one of these special values: * <code>"simple"</code>, <code>"beans"</code>, <code>"jython"</code> (case insensitive). * <li><code>"number_format"</code>: pattern as <code>java.text.DecimalFormat</code> defines. * <li><code>"boolean_format"</code>: the textual value for boolean true and false, * separated with comma. For example <code>"yes,no"</code>. * <li><code>"date_format", "time_format", "datetime_format"</code>: patterns as * <code>java.text.SimpleDateFormat</code> defines. * <li><code>"time_zone"</code>: time zone, with the format as * <code>java.util.TimeZone.getTimeZone</code> defines. For example <code>"GMT-8:00"</code> or * <code>"America/Los_Angeles"</code> * <li><code>"output_encoding"</code>: Informs FreeMarker about the charset * used for the output. As FreeMarker outputs character stream (not * byte stream), it is not aware of the output charset unless the * software that encloses it tells it explicitly with this setting. * Some templates may use FreeMarker features that require this.</code> * <li><code>"url_escaping_charset"</code>: If this setting is set, then it * overrides the value of the <code>"output_encoding"</code> setting when * FreeMarker does URL encoding. * </ul> * * @param key the name of the setting. * @param value the string that describes the new value of the setting. * * @throws UnknownSettingException if the key is wrong. * @throws TemplateException if the new value of the setting can't be set * for any other reasons. */ public void setSetting(String key, String value) throws TemplateException { try { if (LOCALE_KEY.equals(key)) { setLocale(StringUtil.deduceLocale(value)); } else if (NUMBER_FORMAT_KEY.equals(key)) { setNumberFormat(value); } else if (TIME_FORMAT_KEY.equals(key)) { setTimeFormat(value); } else if (DATE_FORMAT_KEY.equals(key)) { setDateFormat(value); } else if (DATETIME_FORMAT_KEY.equals(key)) { setDateTimeFormat(value); } else if (TIME_ZONE_KEY.equals(key)) { setTimeZone(TimeZone.getTimeZone(value)); } else if (TEMPLATE_EXCEPTION_HANDLER_KEY.equals(key)) { if (value.indexOf('.') == -1) { if ("debug".equalsIgnoreCase(value)) { setTemplateExceptionHandler( TemplateExceptionHandler.DEBUG_HANDLER); } else if ("html_debug".equalsIgnoreCase(value)) { setTemplateExceptionHandler( TemplateExceptionHandler.HTML_DEBUG_HANDLER); } else if ("ignore".equalsIgnoreCase(value)) { setTemplateExceptionHandler( TemplateExceptionHandler.IGNORE_HANDLER); } else if ("rethrow".equalsIgnoreCase(value)) { setTemplateExceptionHandler( TemplateExceptionHandler.RETHROW_HANDLER); } else { throw invalidSettingValueException(key, value); } } else { setTemplateExceptionHandler( (TemplateExceptionHandler) ClassUtil.forName(value) .newInstance()); } } else if (ARITHMETIC_ENGINE_KEY.equals(key)) { if (value.indexOf('.') == -1) { if ("bigdecimal".equalsIgnoreCase(value)) { setArithmeticEngine(ArithmeticEngine.BIGDECIMAL_ENGINE); } else if ("conservative".equalsIgnoreCase(value)) { setArithmeticEngine(ArithmeticEngine.CONSERVATIVE_ENGINE); } else { throw invalidSettingValueException(key, value); } } else { setArithmeticEngine( (ArithmeticEngine) ClassUtil.forName(value) .newInstance()); } } else if (OBJECT_WRAPPER_KEY.equals(key)) { if (value.indexOf('.') == -1) { if ("default".equalsIgnoreCase(value)) { setObjectWrapper(new DefaultObjectWrapper()); } else if ("simple".equalsIgnoreCase(value)) { setObjectWrapper(new SimpleObjectWrapper()); } else if ("beans".equalsIgnoreCase(value)) { setObjectWrapper(new BeansWrapper()); } else if ("jython".equalsIgnoreCase(value)) { Class clazz = Class.forName( "freemarker.ext.jython.JythonWrapper"); setObjectWrapper( (ObjectWrapper) clazz.getField("INSTANCE").get(null)); } else { throw invalidSettingValueException(key, value); } } else { setObjectWrapper((ObjectWrapper) ClassUtil.forName(value) .newInstance()); } } else if (BOOLEAN_FORMAT_KEY.equals(key)) { setBooleanFormat(value); } else if (OUTPUT_ENCODING_KEY.equals(key)) { setOutputEncoding(value); } else if (URL_ESCAPING_CHARSET_KEY.equals(key)) { setURLEscapingCharset(value); } else if (STRICT_BEAN_MODELS.equals(key)) { setStrictBeanModels(StringUtil.getYesNo(value)); } else { throw unknownSettingException(key); } } catch(TemplateException e) { throw e; } catch(Exception e) { throw new TemplateException( "Failed to set setting " + key + " to value " + value, e, getEnvironment()); } } public void setStrictBeanModels(boolean strict) { if (!(objectWrapper instanceof BeansWrapper)) { throw new IllegalStateException("Not a beans wrapper"); } ((BeansWrapper) objectWrapper).setStrict(strict); } /** * Returns the textual representation of a setting. * @param key the setting key. Can be any of standard <tt>XXX_KEY</tt> * constants, or a custom key. * * @deprecated This method was always defective, and certainly it always * will be. Don't use it. (Simply, it's hardly possible in general to * convert setting values to text in a way that ensures that * {@link #setSetting(String, String)} will work with them correctly.) */ public String getSetting(String key) { return properties.getProperty(key); } /** * This meant to return the String-to-String <code>Map</code> of the * settings. So it actually should return a <code>Properties</code> object, * but it doesn't by mistake. The returned <code>Map</code> is read-only, * but it will reflect the further configuration changes (aliasing effect). * * @deprecated This method was always defective, and certainly it always * will be. Don't use it. (Simply, it's hardly possible in general to * convert setting values to text in a way that ensures that * {@link #setSettings(Properties)} will work with them correctly.) */ public Map getSettings() { return Collections.unmodifiableMap(properties); } public Environment getEnvironment() { return Environment.getCurrentEnvironment(); } protected TemplateException unknownSettingException(String name) { return new UnknownSettingException(name, getEnvironment()); } protected TemplateException invalidSettingValueException(String name, String value) { return new TemplateException("Invalid value for setting " + name + ": " + value, getEnvironment()); } public static class UnknownSettingException extends TemplateException { private static final long serialVersionUID = 6904771126094186066L; private UnknownSettingException(String name, Environment env) { super("Unknown setting: " + name, env); } } /** * Set the settings stored in a <code>Properties</code> object. * * @throws TemplateException if the <code>Properties</code> object contains * invalid keys, or invalid setting values, or any other error occurs * while changing the settings. */ public void setSettings(Properties props) throws TemplateException { Iterator it = props.keySet().iterator(); while (it.hasNext()) { String key = (String) it.next(); setSetting(key, props.getProperty(key).trim()); } } /** * Reads a setting list (key and element pairs) from the input stream. * The stream has to follow the usual <code>.properties</code> format. * * @throws TemplateException if the stream contains * invalid keys, or invalid setting values, or any other error occurs * while changing the settings. * @throws IOException if an error occurred when reading from the input stream. */ public void setSettings(InputStream propsIn) throws TemplateException, IOException { Properties p = new Properties(); p.load(propsIn); setSettings(p); } /** * Internal entry point for setting unnamed custom attributes */ void setCustomAttribute(Object key, Object value) { synchronized(customAttributes) { customAttributes.put(key, value); } } /** * Internal entry point for getting unnamed custom attributes */ Object getCustomAttribute(Object key, CustomAttribute attr) { synchronized(customAttributes) { Object o = customAttributes.get(key); if(o == null && !customAttributes.containsKey(key)) { o = attr.create(); customAttributes.put(key, o); } return o; } } /** * Sets a named custom attribute for this configurable. * * @param name the name of the custom attribute * @param value the value of the custom attribute. You can set the value to * null, however note that there is a semantic difference between an * attribute set to null and an attribute that is not present, see * {@link #removeCustomAttribute(String)}. */ public void setCustomAttribute(String name, Object value) { synchronized(customAttributes) { customAttributes.put(name, value); } } /** * Returns an array with names of all custom attributes defined directly * on this configurable. (That is, it doesn't contain the names of custom attributes * defined indirectly on its parent configurables.) The returned array is never null, * but can be zero-length. * The order of elements in the returned array is not defined and can change * between invocations. */ public String[] getCustomAttributeNames() { synchronized(customAttributes) { ArrayList<String> names = new ArrayList<String>(customAttributes.size()); for (Object key : customAttributes.keySet()) { if (key instanceof String) { names.add((String) key); } } String[] arr = new String[names.size()]; return names.toArray(arr); } } /** * Removes a named custom attribute for this configurable. Note that this * is different than setting the custom attribute value to null. If you * set the value to null, {@link #getCustomAttribute(String)} will return * null, while if you remove the attribute, it will return the value of * the attribute in the parent configurable (if there is a parent * configurable, that is). * * @param name the name of the custom attribute */ public void removeCustomAttribute(String name) { synchronized(customAttributes) { customAttributes.remove(name); } } /** * Retrieves a named custom attribute for this configurable. If the * attribute is not present in the configurable, and the configurable has * a parent, then the parent is looked up as well. * * @param name the name of the custom attribute * * @return the value of the custom attribute. Note that if the custom attribute * was created with <tt>&lt;#ftl&nbsp;attributes={...}></tt>, then this value is already * unwrapped (i.e. it's a <code>String</code>, or a <code>List</code>, or a * <code>Map</code>, ...etc., not a FreeMarker specific class). */ public Object getCustomAttribute(String name) { Object retval; synchronized(customAttributes) { retval = customAttributes.get(name); if(retval == null && customAttributes.containsKey(name)) { return null; } } if(retval == null && parent != null) { return parent.getCustomAttribute(name); } return retval; } }

The table below shows all metrics for Configurable.java.

MetricValueDescription
BLOCKS105.00Number of blocks
BLOCK_COMMENT51.00Number of block comment lines
COMMENTS306.00Comment lines
COMMENT_DENSITY 0.95Comment density
COMPARISONS75.00Number of comparison operators
CYCLOMATIC116.00Cyclomatic complexity
DECL_COMMENTS36.00Comments in declarations
DOC_COMMENT249.00Number of javadoc comment lines
ELOC323.00Effective lines of code
EXEC_COMMENTS 4.00Comments in executable code
EXITS84.00Procedure exits
FUNCTIONS49.00Number of function declarations
HALSTEAD_DIFFICULTY80.26Halstead difficulty
HALSTEAD_EFFORT 0.00Halstead effort
INTERFACE_COMPLEXITY102.00Interface complexity
JAVA0001 0.00JAVA0001 Package name does not contain only lower case letters
JAVA0002 1.00JAVA0002 Package name does not begin with a top level domain name or country code
JAVA0003 0.00JAVA0003 Minimize use of on-demand (.*) imports
JAVA0004 0.00JAVA0004 Unnecessary import from java.lang
JAVA0005 1.00JAVA0005 Imports not in specified order
JAVA0006 0.00JAVA0006 Empty finally block
JAVA0007 0.00JAVA0007 Should not declare public field
JAVA0008 0.00JAVA0008 Empty catch block
JAVA0009 0.00JAVA0009 Protected member in final class
JAVA0010 1.00JAVA0010 Non-instantiable class does not contain a non-private static member
JAVA0011 0.00JAVA0011 Abstract class does not contain an abstract method
JAVA0012 0.00JAVA0012 Non-constructor method with same name as declaring class
JAVA0013 0.00JAVA0013 Non-blank final field is not static
JAVA0014 0.00JAVA0014 Class with only static members has non-private constructor
JAVA0015 0.00JAVA0015 Package class contains public nested type
JAVA0016 0.00JAVA0016 Abstract class contains public constructor
JAVA0017 0.00JAVA0017 Class name does not have required form
JAVA0018 0.00JAVA0018 Method name does not have required form
JAVA0019 0.00JAVA0019 Interface name does not have required form
JAVA0020 0.00JAVA0020 Field name does not have required form
JAVA0021 0.00JAVA0021 Interface method name does not have required form
JAVA0022 0.00JAVA0022 Static final field name does not have required form
JAVA0023 0.00JAVA0023 Empty finalize method
JAVA0024 0.00JAVA0024 Empty class
JAVA0025 0.00JAVA0025 Method override is empty
JAVA0026 0.00JAVA0026 Finalize method with parameters
JAVA0029 0.00JAVA0029 Private method not used
JAVA0030 0.00JAVA0030 Private field not used
JAVA0031 0.00JAVA0031 Case statement not properly closed
JAVA0032 0.00JAVA0032 Switch statement missing default
JAVA0033 0.00JAVA0033 default: not last case in switch statement
JAVA0034 9.00JAVA0034 Missing braces in if statement
JAVA0035 0.00JAVA0035 Missing braces in for statement
JAVA0036 0.00JAVA0036 Missing braces in while statement
JAVA0038 0.00JAVA0038 Non-case label in switch statement
JAVA0039 0.00JAVA0039 Break statement with label
JAVA0040 0.00JAVA0040 Switch statement contains N cases (maximum: M)
JAVA0041 0.00JAVA0041 Nested synchronized block
JAVA0042 0.00JAVA0042 Empty synchronized statement
JAVA0043 0.00JAVA0043 Inner class does not use outer class
JAVA0044 0.00JAVA0044 Serializable class with no instance variables
JAVA0045 0.00JAVA0045 Serializable class with only transient fields
JAVA0046 0.00JAVA0046 Name of class not derived from Exception ends with 'Exception'
JAVA0047 0.00JAVA0047 Serializable class derives from invalid base class
JAVA0048 0.00JAVA0048 Name of class derived from Exception does not end with 'Exception'
JAVA0049 0.00JAVA0049 Nested block at depth N (maximum: M)
JAVA0050 0.00JAVA0050 Class derives from java.lang.Error
JAVA0051 0.00JAVA0051 Class derives from java.lang.RuntimeException
JAVA0052 0.00JAVA0052 Class derives from java.lang.Throwable
JAVA0053 0.00JAVA0053 Unused label
JAVA0054 0.00JAVA0054 Inheritance depth N exceeds maximum M
JAVA0055 0.00JAVA0055 Class should be interface
JAVA0056 0.00JAVA0056 Unnecessary abstract modifier for interface or annotation
JAVA0057 0.00JAVA0057 Unnecessary default constructor
JAVA0058 0.00JAVA0058 Constructor calls super()
JAVA0059 0.00JAVA0059 Method override only calls super()
JAVA0061 0.00JAVA0061 Inaccessible member in anonymous class
JAVA0062 1.00JAVA0062 Public class missing public member or protected constructor
JAVA0063 0.00JAVA0063 Identifier name should not contain '$'
JAVA0064 1.00JAVA0064 N variations of identifier name (maximum: M)
JAVA0065 0.00JAVA0065 Unnecessary final modifier for method in final class
JAVA0066 0.00JAVA0066 Unnecessary modifier for interface nested type
JAVA0067 0.00JAVA0067 Array descriptor on identifier name
JAVA0068 0.00JAVA0068 Modifiers not declared in recommended order
JAVA0071 0.00JAVA0071 Strings compared with ==
JAVA0073 0.00JAVA0073 Integer division in floating-point context
JAVA0074 0.00JAVA0074 Use of Object.notify()
JAVA0075 0.00JAVA0075 Method parameter hides field
JAVA0076 0.00JAVA0076 Use of magic number
JAVA0077 0.00JAVA0077 Private field not used in declaring class
JAVA0078 0.00JAVA0078 Floating point values compared with ==
JAVA0079 0.00JAVA0079 Use of instance to reference static member
JAVA0080 0.00JAVA0080 Import declaration not used
JAVA0081 0.00JAVA0081 Boolean literal in comparison
JAVA0082 0.00JAVA0082 Unnecessary widening cast
JAVA0083 0.00JAVA0083 Unnecessary instanceof test
JAVA0084 0.00JAVA0084 Should use compound assignment operator
JAVA0085 0.00JAVA0085 Use of sun.* class
JAVA0087 0.00JAVA0087 Use of Thread.sleep()
JAVA0089 0.00JAVA0089 Use of restricted package
JAVA0092 0.00JAVA0092 Use of restricted type
JAVA0093 0.00JAVA0093 Redundant assignment
JAVA0094 0.00JAVA0094 Field hides a superclass field
JAVA0095 0.00JAVA0095 Uninitialized private field
JAVA0096 0.00JAVA0096 Field in nested class hides outer field
JAVA0098 0.00JAVA0098 Minimize use of implicit field initializers
JAVA0100 1.00JAVA0100 Class contains N non-final fields (maximum: M)
JAVA0101 0.00JAVA0101 Unnecessary modifier for field in interface
JAVA0102 0.00JAVA0102 Last statement in finalize() not super.finalize()
JAVA0103 0.00JAVA0103 Explicit call to finalize()
JAVA0104 0.00JAVA0104 finalize() only calls super.finalize()
JAVA0105 0.00JAVA0105 Duplicate import declaration
JAVA0106 0.00JAVA0106 Unnecessary import from current package
JAVA010816.00JAVA0108 Incorrect javadoc: no @param tag for 'parameter'
JAVA0109 0.00JAVA0109 Incorrect javadoc: no parameter 'parameter'
JAVA011013.00JAVA0110 Incorrect javadoc: no @return tag
JAVA0111 0.00JAVA0111 Incorrect javadoc: @return tag for void method
JAVA0112 1.00JAVA0112 Incorrect javadoc: no exception 'exception' in throws
JAVA0113 0.00JAVA0113 Incorrect javadoc: no @author tag
JAVA0114 0.00JAVA0114 Incorrect javadoc: no @version tag
JAVA0115 0.00JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception'
JAVA011613.00JAVA0116 Missing javadoc: field 'field'
JAVA011711.00JAVA0117 Missing javadoc: method 'method'
JAVA0118 1.00JAVA0118 Missing javadoc: type 'type'
JAVA0119 0.00JAVA0119 Control variable changed within body of for loop
JAVA0123 0.00JAVA0123 Use all three components of for loop
JAVA0125 0.00JAVA0125 Continue statement with label
JAVA0126 0.00JAVA0126 Method declares unchecked exception in throws
JAVA0128 0.00JAVA0128 Public constructor in non-public class
JAVA0130 0.00JAVA0130 Non-static method does not use instance fields
JAVA0131 0.00JAVA0131 Compatible method does not override base
JAVA0132 1.00JAVA0132 Method overload with compatible signature
JAVA0133 0.00JAVA0133 Non-synchronized method overrides synchronized method
JAVA0135 0.00JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method'
JAVA0136 1.00JAVA0136 N methods defined in class (maximum: M)
JAVA0137 0.00JAVA0137 Non-abstract class missing constructor
JAVA0138 0.00JAVA0138 N parameters defined for method (maximum: M)
JAVA0139 0.00JAVA0139 Definition of main other than public static void main(java.lang.String[])
JAVA0141 0.00JAVA0141 Unnecessary modifier for method in interface
JAVA0143 0.00JAVA0143 Synchronized method
JAVA0144 2.00JAVA0144 Line exceeds maximum M characters
JAVA014511.00JAVA0145 Tab character used in source file
JAVA0150 0.00JAVA0150 java.lang.Error (or subclass) thrown
JAVA0153 0.00JAVA0153 Inefficient conversion of integer to string
JAVA0159 0.00JAVA0159 Inefficient conversion of string to integer
JAVA0160 0.00JAVA0160 Method does not throw specified exception
JAVA0161 0.00JAVA0161 Conditional wait() not in loop
JAVA0163 0.00JAVA0163 Empty statement
JAVA0165 0.00JAVA0165 Conflicting return statement in finally block
JAVA0166 1.00JAVA0166 Generic exception caught
JAVA0167 0.00JAVA0167 ThreadDeath not rethrown
JAVA0169 0.00JAVA0169 Unnecessary catch block: exception 'exception'
JAVA0170 0.00JAVA0170 Caught exception not derived from java.lang.Exception
JAVA0171 0.00JAVA0171 Unused local variable
JAVA0173 1.00JAVA0173 Unused method parameter
JAVA0174 0.00JAVA0174 Assigned local variable never used
JAVA0175 0.00JAVA0175 Successive assignment to variable
JAVA0176 0.00JAVA0176 Local variable name does not have required form
JAVA0177 1.00JAVA0177 Variable declaration missing initializer
JAVA0179 0.00JAVA0179 Local variable hides visible field
JAVA0233 0.00JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID'
JAVA0234 0.00JAVA0234 Class is Serializable but does not define serialVersionUID
JAVA0235 0.00JAVA0235 Class defines serialVersionUID but does not implement Serializable
JAVA0236 0.00JAVA0236 Attempt to clone an object which does not implement Cloneable
JAVA0237 0.00JAVA0237 Class implements Cloneable but does not have public clone method
JAVA0238 0.00JAVA0238 Clone method does not call super.clone()
JAVA0239 0.00JAVA0239 Class declares 'readObject' or 'writeObject' but does not implement Serializable
JAVA0240 0.00JAVA0240 Serializable class which declares readObject or writeObject but not both
JAVA0241 0.00JAVA0241 'readObject' or 'writeObject' should be declared private in Serializable class
JAVA0242 0.00JAVA0242 Transient field in non-Serializable class
JAVA0243 0.00JAVA0243 'readResolve' or 'writeReplace' should be declared private or protected
JAVA0244 0.00JAVA0244 Field or method name in subclass differs only by case from inherited field or method
JAVA0245 0.00JAVA0245 JUnit TestCase with non-trivial constructor
JAVA0246 0.00JAVA0246 JUnit assertXXX statement missing message parameter
JAVA0247 0.00JAVA0247 JUnit 'setUp()' and 'tearDown()' should call super method
JAVA0248 0.00JAVA0248 JUnit method 'setUp' or 'tearDown' with incorrect signature
JAVA0249 0.00JAVA0249 JUnit TestCase 'suite()' should be declared static
JAVA0250 0.00JAVA0250 JUnit TestCase declares testXXX method with incorrect signature
JAVA0251 0.00JAVA0251 Use '%n' for line breaks in printf/format for platform independence
JAVA0252 0.00JAVA0252 'enum' is a Java 1.5 reserved word
JAVA0253 0.00JAVA0253 Not all enum constants consumed in switch statement
JAVA0254 1.00JAVA0254 Use enhanced for loop construct instead of Iterator
JAVA0255 0.00JAVA0255 Result of method invocation not used
JAVA0256 0.00JAVA0256 Assignment of external collection/array to field
JAVA0257 0.00JAVA0257 Use of 'Constant Interface' anti-pattern
JAVA0258 0.00JAVA0258 Implement Iterable for foreach compatibility
JAVA0259 0.00JAVA0259 Return of collection/array field
JAVA0260 0.00JAVA0260 Use 'enum' instead of Enumerated Type pattern
JAVA0261 0.00JAVA0261 Use specialized Enum collection types
JAVA0262 0.00JAVA0262 Use of char in integer context
JAVA0263 0.00JAVA0263 Long literal ends with 'l' instead of 'L'
JAVA0264 0.00JAVA0264 Integer math in long context - check for overflow
JAVA0265 0.00JAVA0265 Use of Throwable.printStackTrace()
JAVA0266 0.00JAVA0266 Use of System.out
JAVA0267 0.00JAVA0267 Use of System.err
JAVA0269 0.00JAVA0269 Contents of StringBuffer never used
JAVA0270 0.00JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array
JAVA0271 0.00JAVA0271 Minimize use of on-demand (.*) static imports
JAVA0272 0.00JAVA0272 Thread.run() called
JAVA0273 0.00JAVA0273 Non-final derivative of Thread calls start() in constructor
JAVA0274 0.00JAVA0274 Serializable class has a synchronized readObject()
JAVA0275 0.00JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods
JAVA0276 0.00JAVA0276 Unnecessary use of String constructor
JAVA0277 0.00JAVA0277 Iterator.next() implementation does not throw NoSuchElementException
JAVA0278 0.00JAVA0278 Unnecessary use of Boolean constructor
JAVA0279 0.00JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method
JAVA0280 0.00JAVA0280 IllegalMonitorStateException caught
JAVA0281 0.00JAVA0281 Iterator.next() not called in loop
JAVA0282 0.00JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext()
JAVA0283 0.00JAVA0283 Control variable not updated in loop body
JAVA0284 0.00JAVA0284 Explicit garbage collection
JAVA0285 0.00JAVA0285 Dereference of potentially null variable
JAVA0286 0.00JAVA0286 Dereference of null variable
JAVA0287 0.00JAVA0287 Unnecessary null check
JAVA0288 0.00JAVA0288 Inconsistent null check
LINES769.00Number of lines in the source file
LINE_COMMENT 6.00Number of line comments
LOC402.00Lines of code
LOGICAL_LINES196.00Number of statements
LOOPS 1.00Number of loops
NEST_DEPTH 5.00Maximum nesting depth
OPERANDS875.00Number of operands
OPERATORS1767.00Number of operators
PARAMS35.00Number of formal parameter declarations
PROGRAM_LENGTH2642.00Halstead program length
PROGRAM_VOCAB329.00Halstead program vocabulary
PROGRAM_VOLUME 0.00Halstead program volume
RETURNS67.00Number of return points from functions
SIZE32784.00Size of the file in bytes
UNIQUE_OPERANDS278.00Number of unique operands
UNIQUE_OPERATORS51.00Number of unique operators
WHITESPACE61.00Number of whitespace lines