com.massa.mrules.addon

Class MAddonsUtils

java.lang.Object

com.massa.mrules.addon.MAddonsUtils

public final class MAddonsUtils
extends Object

Provides utility methods on addons.

Method Summary

Modifier and Type	Method and Description
static <A extends IAddon> A	cloneAddon(A a) Clones an Addon, handling correctly null values.
static <C extends Collection<G>,G extends IAddon> C	cloneAddons(C c) Clones a Collection of Addons, using the same Collection type as the one provided.
static void	debugEntering(IExecutionContext ctxt, IAddon addon) Convenient method designed to be called at beginning of execution method of an addon.
static void	debugExitError(IExecutionContext ctxt, IAddon addon, Throwable t) Convenient method designed to be called at end of execution method of an addon.
static void	debugExiting(IExecutionContext ctxt, IAddon addon) Convenient method designed to be called at end of execution method of an addon.
static void	debugExiting(IExecutionContext ctxt, IAddon addon, Object result) Convenient method designed to be called at end of execution method of an addon.
static void	enterCompile(ICompilationContext ctxt, IAddon addon, String compileType) Logs at compilation beginning. compileType might be provided to add information or be null to be ignored.
static void	exitCompile(ICompilationContext ctxt, IAddon addon, String compileType) Logs at compilation ending. compileType might be provided to add information or be null to be ignored.
static IEvaluationOperator	getEvaluationOperator(String name) Retrieves operator implementation from registered addons.
static ILogicalOperator	getLogicalOperator(String name) Retrieves operator implementation from registered addons.
static PersistantPropertiesTable	getPersistantProperties(Class<?> clazz) Returns the provided class' PersistantProperties (name --> default value).
static PersistantPropertiesTable	getPersistantProperties(Object object) Returns the provided object's class' PersistantProperties (name --> default value).
static Map<String,Object>	getPersistantPropertiesValues(Object object, boolean includeDefaults) Returns the provided object's class' PersistantProperties values, including or not values that are equal to defaults (name --> value).
static boolean	hasPersistantProperties(Class<?> clazz) Tells if the provided class has PersistantProperties annotation defined.
static boolean	hasPersistantProperties(Object object) Tells if the provided object's class has PersistantProperties annotation defined.
static boolean	isCacheUsed(Iterable<? extends IAddon> addons) Tells if cached is used by all addons using cache in this list.
static IAddon	unwrap(IAddon value) Unwraps the provided addon if wrapped.
static Object	unwrap(Object value) Convenience method to unwrap the provided object if it's an Addon.
static <T extends IAddon> T	wrap(Class<T> type, IAddon value) Allows to automatically wrap an Addon by another, in order to directly use result.

Methods inherited from class java.lang.Object

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

Method Detail

cloneAddons

public static <C extends Collection<G>,G extends IAddon> C cloneAddons(C c)

Clones a Collection of Addons, using the same Collection type as the one provided.

Parameters:

c - Collection of addons.

Returns:

New collection of clones

cloneAddon

public static <A extends IAddon> A cloneAddon(A a)

Clones an Addon, handling correctly null values.

Parameters:

a - Addon.

Returns:

New clone

isCacheUsed

public static boolean isCacheUsed(Iterable<? extends IAddon> addons)

Tells if cached is used by all addons using cache in this list.

getPersistantPropertiesValues

public static Map<String,Object> getPersistantPropertiesValues(Object object,
                                                               boolean includeDefaults)
                                                        throws MRuleInternalException

Returns the provided object's class' PersistantProperties values, including or not values that are equal to defaults (name --> value).

Throws:

MRuleInternalException

getPersistantProperties

public static PersistantPropertiesTable getPersistantProperties(Object object)

Returns the provided object's class' PersistantProperties (name --> default value).

getPersistantProperties

public static PersistantPropertiesTable getPersistantProperties(Class<?> clazz)

Returns the provided class' PersistantProperties (name --> default value). Result is never null.

hasPersistantProperties

public static boolean hasPersistantProperties(Object object)

Tells if the provided object's class has PersistantProperties annotation defined.

hasPersistantProperties

public static boolean hasPersistantProperties(Class<?> clazz)

Tells if the provided class has PersistantProperties annotation defined.

wrap

public static <T extends IAddon> T wrap(Class<T> type,
                                        IAddon value)

Allows to automatically wrap an Addon by another, in order to directly use result. For instance, to use result of a condition as a boolean accessor.

See Also:

MConditionWrapperAccessor, MAccessorWrapperCondition

unwrap

public static Object unwrap(Object value)

Convenience method to unwrap the provided object if it's an Addon. If not returns the value.

unwrap

public static IAddon unwrap(IAddon value)

Unwraps the provided addon if wrapped. Otherwise returns the same value as provided.

getLogicalOperator

public static ILogicalOperator getLogicalOperator(String name)
                                           throws UtilsException

Retrieves operator implementation from registered addons.

Parameters:

name - Unique operator name.

Throws:

UtilsException

getEvaluationOperator

public static IEvaluationOperator getEvaluationOperator(String name)
                                                 throws UtilsException

Retrieves operator implementation from registered addons.

Parameters:

name - Unique operator name.

Throws:

UtilsException

exitCompile

public static void exitCompile(ICompilationContext ctxt,
                               IAddon addon,
                               String compileType)

Logs at compilation ending. compileType might be provided to add information or be null to be ignored.

debugEntering

public static void debugEntering(IExecutionContext ctxt,
                                 IAddon addon)

Convenient method designed to be called at beginning of execution method of an addon. Responsible for testing debug mode.

debugExiting

public static void debugExiting(IExecutionContext ctxt,
                                IAddon addon)

Convenient method designed to be called at end of execution method of an addon. Responsible for testing debug mode.

debugExitError

public static void debugExitError(IExecutionContext ctxt,
                                  IAddon addon,
                                  Throwable t)

Convenient method designed to be called at end of execution method of an addon. Responsible for testing debug mode.

debugExiting

public static void debugExiting(IExecutionContext ctxt,
                                IAddon addon,
                                Object result)

Convenient method designed to be called at end of execution method of an addon. Responsible for testing debug mode.

enterCompile

public static void enterCompile(ICompilationContext ctxt,
                                IAddon addon,
                                String compileType)

Logs at compilation beginning. compileType might be provided to add information or be null to be ignored.