org.springframework.extensions.directives

Class DirectiveUtils

java.lang.Object

org.springframework.extensions.directives.DirectiveUtils

public class DirectiveUtils
extends Object

Constructor Summary

Constructors

Constructor and Description
DirectiveUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	getBooleanProperty(Map<String,Object> params, String targetProp, String directiveName, boolean required) Attempts to retrieve a boolean property from the map of parameters supplied using the key provided.
static String	getStringProperty(Map<String,Object> params, String targetProp, String directiveName, boolean required) Attempts to retrieve a String property from the map of parameters supplied using the key provided.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DirectiveUtils

public DirectiveUtils()

Method Detail

getStringProperty

public static String getStringProperty(Map<String,Object> params,
                       String targetProp,
                       String directiveName,
                       boolean required)
                                throws freemarker.template.TemplateModelException

Attempts to retrieve a String property from the map of parameters supplied using the key provided.

• If a property is found but it is not a String then an exception will be thrown.
• If a property is not found and not required then null will be returned.
• If a property is not found and is required then an exception will be thrown

Parameters:

params - A map of parameters (this is supplied to the execute method that must be implemented by subclasses.

targetProp - The name of the property to attempt to retrieve.

required - Indicates whether or not the property is required for the directive to process successfully.

Returns:

A String value for the property name supplied (or null if it could not be found)

Throws:

freemarker.template.TemplateModelException - When a property matching the supplied name is found but is not a String.

getBooleanProperty

public static boolean getBooleanProperty(Map<String,Object> params,
                         String targetProp,
                         String directiveName,
                         boolean required)
                                  throws freemarker.template.TemplateModelException

Attempts to retrieve a boolean property from the map of parameters supplied using the key provided.

• If a property is found but it is not a boolean then an exception will be thrown.
• If a property is not found and not required then false will be returned.
• If a property is not found and is required then an exception will be thrown

Parameters:

params - A map of parameters (this is supplied to the execute method that must be implemented by subclasses.

targetProp - The name of the property to attempt to retrieve.

required - Indicates whether or not the property is required for the directive to process successfully.

Returns:

A boolean value for the property name supplied (or false if it could not be found)

Throws:

freemarker.template.TemplateModelException - When a property matching the supplied name is found but is not a boolean.