Difference between revisions of "PropertiesHandler"

From GreenVulcano Wiki
Jump to: navigation, search
(Created page with "Class FQN: '''it.greenvulcano.util.metadata.PropertiesHandler''' /** * Helper class for metadata substitution in strings. * * @version 3.0.0 Feb 17, 2010 * @author GreenVulc...")
 
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
 
Class FQN: '''it.greenvulcano.util.metadata.PropertiesHandler'''
 
Class FQN: '''it.greenvulcano.util.metadata.PropertiesHandler'''
  
 +
See also [[Placeholders]]
 +
 +
<syntaxhighlight lang="java5">
 
/**
 
/**
 
  * Helper class for metadata substitution in strings.
 
  * Helper class for metadata substitution in strings.
 
  *
 
  *
  * @version 3.0.0 Feb 17, 2010
+
  * Search the classpath for a file named PropertiesHandler.properties containing,
  * @author GreenVulcano Developer Team
+
  * one at line, the FQN of classes implementing PropertyHandler interface, the
  *
+
  * found classes are instantiated and registered.
 
  *
 
  *
 
  **/
 
  **/
 +
</syntaxhighlight>
  
==Following the PropertiesHandler public static methods==
+
==PropertiesHandler public static methods==
 
 
 
<syntaxhighlight lang="java5">
 
<syntaxhighlight lang="java5">
 +
/**
 +
* This method inserts the correct values for the dynamic parameter found in
 +
* the input string.
 +
*
 +
* @param str
 +
*        the string to evaluate
 +
* @return the expanded string
 +
*
 +
* @throws PropertiesHandlerException
 +
*        if error occurs and the flag THROWS_EXCEPTION is set
 +
*/
 +
public static String expand(String str) throws PropertiesHandlerException
  
    /**
+
/**
    * @param type
+
* This method inserts the correct values for the dynamic parameter found in
    * @param handler
+
* the input string.
    */
+
*
    public static void registerHandler(String type, PropertyHandler handler)
+
* @param str
 +
*        the string to evaluate
 +
* @param inProperties
 +
*        the hashTable containing the properties
 +
* @return the expanded string
 +
*
 +
* @throws PropertiesHandlerException
 +
*        if error occurs and the flag THROWS_EXCEPTION is set
 +
*/
 +
public static String expand(String str, Map<String, Object> inProperties) throws PropertiesHandlerException
  
 +
/**
 +
* This method inserts the correct values for the dynamic parameter found in
 +
* the input string.
 +
*
 +
* @param str
 +
*        the string to evaluate
 +
* @param inProperties
 +
*        the hashTable containing the properties
 +
* @param obj
 +
*        the object to work with
 +
* @return the expanded string
 +
*
 +
* @throws PropertiesHandlerException
 +
*        if error occurs and the flag THROWS_EXCEPTION is set
 +
*/
 +
public static String expand(String str, Map<String, Object> inProperties, Object obj)
 +
        throws PropertiesHandlerException
  
    /**
+
/**
    * This method insert the correct values for the dynamic parameter found in
+
* This method inserts the correct values for the dynamic parameter found in
    * the input string. The property value can be a combination of: - fixed : a
+
* the input string.
    * text string; - ${{propname}} : a System property name.
+
*
    *
+
* @param str
    * @param str
+
*        the string to evaluate
    *        the string to value
+
* @param inProperties
    * @return the expanded string
+
*       the hashTable containing the properties
    *
+
* @param obj
    * @throws PropertiesHandlerException
+
*        the object to work with
    *        if error occurs and the flag THROWS_EXCEPTION is set
+
* @param scope
    */
+
*        the JavaScript scope
    public static String expand(String str) throws PropertiesHandlerException
+
* @return the expanded string
 +
*
 +
* @throws PropertiesHandlerException
 +
*        if error occurs and the flag THROWS_EXCEPTION is set
 +
*/
 +
public static String expand(String str, Map<String, Object> inProperties, Object obj, Scriptable scope)
 +
        throws PropertiesHandlerException
  
 +
/**
 +
* This method inserts the correct values for the dynamic parameter found in
 +
* the input string.
 +
*
 +
* @param str
 +
*        the string to evaluate
 +
* @param inProperties
 +
*        the hashTable containing the properties
 +
* @param obj
 +
*        the object to work with
 +
* @param scope
 +
*        the JavaScript scope
 +
* @param extra
 +
*        a extra object passed to property handlers
 +
* @return the expanded string
 +
*
 +
* @throws PropertiesHandlerException
 +
*        if error occurs and the flag THROWS_EXCEPTION is set
 +
*/
 +
public static String expand(String str, Map<String, Object> inProperties, Object obj, Scriptable scope, Object extra)
 +
        throws PropertiesHandlerException
  
    /**
+
/**
    * This method insert the correct values for the dynamic parameter found in
+
* Enables the exception throwing on errors, for the current thread.
    * the input string. The property value can be a combination of: - fixed : a
+
*
    * text string; - ${{propname}} : a System property name; - @{{propname}} :
+
* Example:
    * a inProperties property name;
+
*
    *
+
* <pre>
    * @param str
+
*
    *        the string to value
+
*     ...
    * @param inProperties
+
*     PropertiesHandler.enableExceptionOnErrors();
    *       the hashTable containing the properties
+
*    try {
    * @return the expanded string
+
*        ...
    *
+
*        String value = PropertiesHandler.expand(...);
    * @throws PropertiesHandlerException
+
*       ...
    *         if error occurs and the flag THROWS_EXCEPTION is set
+
*     }
    */
+
*     catch (PropertiesHandlerException exc) {
    public static String expand(String str, Map<String, Object> inProperties) throws PropertiesHandlerException
+
*        ...
 +
*     }
 +
*     finally {
 +
*       PropertiesHandler.disableExceptionOnErrors();
 +
*     }
 +
*
 +
* </pre>
 +
*/
 +
public static void enableExceptionOnErrors()
  
 +
/**
 +
* Disables the exception throwing on errors, for the current thread.
 +
*
 +
*/
 +
public static void disableExceptionOnErrors()
  
    /**
+
/**
    * This method insert the correct values for the dynamic parameter found in
+
* Checks if the exception throwing on errors is enabled for the current
    * the input string. The property value can be a combination of: - fixed : a
+
* thread.
    * text string; - %{{class}} : the object class name; - %{{fqclass}} : the
+
*
    * object fully qualified class name; - %{{package}} : the object package
+
* @return if the exception throwing on errors is enabled for the current
    * name; - ${{propname}} : a System property name; - @{{propname}} : a
+
*         thread.
    * inProperties property name;
+
*
    *
+
*/
    * @param str
+
public static boolean isExceptionOnErrors()
    *        the string to value
 
    * @param inProperties
 
    *        the hashTable containing the properties
 
    * @param obj
 
    *        the object to work with
 
    * @return the expanded string
 
    *
 
    * @throws PropertiesHandlerException
 
    *         if error occurs and the flag THROWS_EXCEPTION is set
 
    */
 
    public static String expand(String str, Map<String, Object> inProperties, Object obj)
 
            throws PropertiesHandlerException
 
  
 
+
/**
    /**
+
* Checks if the input string need to be processed.
    * This method insert the correct values for the dynamic parameter found in
+
*
    * the input string. The property value can be a combination of: - fixed : a
+
* @param str
    * text string; - %{{class}} : the object class name; - %{{fqclass}} : the
+
*        the string to check
    * object fully qualified class name; - %{{package}} : the obj package name;
+
* @return true if the string is processed
    * - ${{propname}} : a System property name; - @{{propname}} : a
+
*/
    * inProperties property name; - &{{script}} : a JavaScript script;
+
public static boolean isExpanded(String str)
    *
 
    * @param str
 
    *        the string to value
 
    * @param inProperties
 
    *        the hashTable containing the properties
 
    * @param obj
 
    *        the object to work with
 
    * @param scope
 
    *        the JavaScript scope
 
    * @return the expanded string
 
    *
 
    * @throws PropertiesHandlerException
 
    *        if error occurs and the flag THROWS_EXCEPTION is set
 
    */
 
    public static String expand(String str, Map<String, Object> inProperties, Object obj, Scriptable scope)
 
            throws PropertiesHandlerException
 
 
 
 
 
    /**
 
    * This method insert the correct values for the dynamic parameter found in
 
    * the input string. The property value can be a combination of: - fixed : a
 
    * text string; - %{{class}} : the object class name; - %{{fqclass}} : the
 
    * object fully qualified class name; - %{{package}} : the object package
 
    * name; - ${{propname}} : a System property name; - @{{propname}} : a
 
    * inProperties property name; - &{{script}} : a JavaScript script;
 
    *
 
    * @param str
 
    *        the string to value
 
    * @param inProperties
 
    *        the hashTable containing the properties
 
    * @param obj
 
    *        the object to work with
 
    * @param scope
 
    *        the JavaScript scope
 
    * @param extra
 
    *        a extra object passed to property handlers
 
    * @return the expanded string
 
    *
 
    * @throws PropertiesHandlerException
 
    *        if error occurs and the flag THROWS_EXCEPTION is set
 
    */
 
    public static String expand(String str, Map<String, Object> inProperties, Object obj, Scriptable scope, Object extra)
 
            throws PropertiesHandlerException
 
 
 
 
 
    /**
 
    * @param type
 
    * @param value
 
    * @param inProperties
 
    * @param obj
 
    * @param scope
 
    * @param extra
 
    *        a extra object passed to property handlers
 
    * @return the expanded string
 
    * @throws PropertiesHandlerException
 
    */
 
    public static String expandInternal(String type, String value, Map<String, Object> inProperties, Object obj,
 
            Scriptable scope, Object extra) throws PropertiesHandlerException
 
 
 
    /**
 
    * @param token
 
    * @param mdt
 
    */
 
    private static void parse(PropertyToken token, MetaDataTokenizer mdt)
 
 
 
 
 
    /**
 
    * Enable the exception throwing on errors, for the current thread.
 
    *
 
    * Example:
 
    *
 
    * <pre>
 
    *
 
    *    ...
 
    *    PropertiesHandler.enableExceptionOnErrors();
 
    *    try {
 
    *        ...
 
    *        String value = PropertiesHandler.expand(...);
 
    *        ...
 
    *    }
 
    *    catch (PropertiesHandlerException exc) {
 
    *        ...
 
    *    }
 
    *    finally {
 
    *        PropertiesHandler.disableExceptionOnErrors();
 
    *    }
 
    *
 
    * </pre>
 
    */
 
    public static void enableExceptionOnErrors()
 
 
 
 
 
    /**
 
    * Disable the exception throwing on errors, for the current thread.
 
    *
 
    */
 
    public static void disableExceptionOnErrors()
 
 
 
 
 
    /**
 
    * Check if the exception throwing on errors is enabled for the current
 
    * thread.
 
    *
 
    * @return if the exception throwing on errors is enabled for the current
 
    *        thread.
 
    *
 
    */
 
    public static boolean isExceptionOnErrors()
 
 
 
    /**
 
    * Check if the input string need to be processed.
 
    *
 
    * @param str
 
    *        the string to check
 
    * @return true if the string is processed
 
    */
 
    public static boolean isExpanded(String str)
 
 
</syntaxhighlight>
 
</syntaxhighlight>

Latest revision as of 18:03, 21 December 2012

Class FQN: it.greenvulcano.util.metadata.PropertiesHandler

See also Placeholders

/**
 * Helper class for metadata substitution in strings.
 *
 * Search the classpath for a file named PropertiesHandler.properties containing,
 * one at line, the FQN of classes implementing PropertyHandler interface, the 
 * found classes are instantiated and registered.
 *
 **/

PropertiesHandler public static methods

/**
* This method inserts the correct values for the dynamic parameter found in
* the input string.
*
* @param str
*        the string to evaluate
* @return the expanded string
*
* @throws PropertiesHandlerException
*         if error occurs and the flag THROWS_EXCEPTION is set
*/
public static String expand(String str) throws PropertiesHandlerException

/**
* This method inserts the correct values for the dynamic parameter found in
* the input string.
*
* @param str
*        the string to evaluate
* @param inProperties
*        the hashTable containing the properties
* @return the expanded string
*
* @throws PropertiesHandlerException
*         if error occurs and the flag THROWS_EXCEPTION is set
*/
public static String expand(String str, Map<String, Object> inProperties) throws PropertiesHandlerException

/**
* This method inserts the correct values for the dynamic parameter found in
* the input string.
*
* @param str
*        the string to evaluate
* @param inProperties
*        the hashTable containing the properties
* @param obj
*        the object to work with
* @return the expanded string
*
* @throws PropertiesHandlerException
*         if error occurs and the flag THROWS_EXCEPTION is set
*/
public static String expand(String str, Map<String, Object> inProperties, Object obj)
         throws PropertiesHandlerException

/**
* This method inserts the correct values for the dynamic parameter found in
* the input string.
*
* @param str
*        the string to evaluate
* @param inProperties
*        the hashTable containing the properties
* @param obj
*        the object to work with
* @param scope
*        the JavaScript scope
* @return the expanded string
*
* @throws PropertiesHandlerException
*         if error occurs and the flag THROWS_EXCEPTION is set
*/
public static String expand(String str, Map<String, Object> inProperties, Object obj, Scriptable scope)
         throws PropertiesHandlerException

/**
* This method inserts the correct values for the dynamic parameter found in
* the input string.
*
* @param str
*        the string to evaluate
* @param inProperties
*        the hashTable containing the properties
* @param obj
*        the object to work with
* @param scope
*        the JavaScript scope
* @param extra
*        a extra object passed to property handlers
* @return the expanded string
*
* @throws PropertiesHandlerException
*         if error occurs and the flag THROWS_EXCEPTION is set
*/
public static String expand(String str, Map<String, Object> inProperties, Object obj, Scriptable scope, Object extra)
         throws PropertiesHandlerException

/**
* Enables the exception throwing on errors, for the current thread.
*
* Example:
*
* <pre>
*
*     ...
*     PropertiesHandler.enableExceptionOnErrors();
*     try {
*        ...
*        String value = PropertiesHandler.expand(...);
*        ...
*     }
*     catch (PropertiesHandlerException exc) {
*        ...
*     }
*     finally {
*        PropertiesHandler.disableExceptionOnErrors();
*     }
*
* </pre>
*/
public static void enableExceptionOnErrors()

/**
* Disables the exception throwing on errors, for the current thread.
*
*/
public static void disableExceptionOnErrors()

/**
* Checks if the exception throwing on errors is enabled for the current
* thread.
*
* @return if the exception throwing on errors is enabled for the current
*         thread.
*
*/
public static boolean isExceptionOnErrors()

/**
* Checks if the input string need to be processed.
*
* @param str
*        the string to check
* @return true if the string is processed
*/
public static boolean isExpanded(String str)