com.massa.mrules.util.property

Class GlobalVarProperty

java.lang.Object

com.massa.util.property.AbstractProperty

com.massa.mrules.util.property.GlobalVarProperty

All Implemented Interfaces:

IProperty2, IProperty, Serializable

public class GlobalVarProperty
extends AbstractProperty
implements IProperty2

Specific implementation allowing to access global variables (starting with #).

Since:

1.8.0 (This code was previously mixed in SimpleProperty2, but has been externalized for performance and maintainability reasons.)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GlobalVarProperty(ICompilationContext ctxt, String property)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Object	get(IPropertySource source, boolean instantiateAll) Introspects source to retrieve property value.
Class<?>	getGenericCollectionType(IPropertySource source) Tries to detect if the generic type of the property if the type is a Collection, knowing the argument type to use.
Class<?>	getGenericMapKeyType(IPropertySource source) Tries to detect if the generic key type of the property if the type is a Map, knowing the argument type to use.
Class<?>	getGenericMapValueType(IPropertySource source) Tries to detect if the generic value type of the property if the type is a Map, knowing the argument type to use.
Class<?>[]	getGenericTypes(IPropertySource source) Tries to detect if the parameterized types of the property, whatever its type is, knowing the argument type to use.
Class<?>	getType(IPropertySource source) Tries to detect if the type of the property, knowing the argument type to use.
int	hashCode()
boolean	isGlobalVar() This property is an access to global variable.
boolean	isLocalVar() This property is an access to local variable.
boolean	isReadable(IPropertySource source) Tries to detect if the property will be able to be read in theory, knowing the argument type to use.
boolean	isVar() This property is an access to local or global variable.
boolean	isWriteable(IPropertySource target) Tries to detect if the property will be able to be written in theory, knowing the argument type to use.
void	optimize(ICompilationContext ctxt, IPropertySource source) Allows to optimize access if target type is known.
void	parentWasRegistered(ICompilationContext ctxt, IAddon parent) Notifies this property that the owner has been registered in compilation context.
Object	set(IPropertySource target, Object obj, boolean instanciateNested) Introspects target to set property value.

Methods inherited from class com.massa.util.property.AbstractProperty

get, getGenericCollectionType, getGenericMapKeyType, getGenericMapValueType, getGenericTypes, getType, isReadable, isWriteable, set

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.massa.util.property.IProperty

get, getGenericCollectionType, getGenericMapKeyType, getGenericMapValueType, getGenericTypes, getType, isReadable, isWriteable, set

Constructor Detail

GlobalVarProperty

public GlobalVarProperty(ICompilationContext ctxt,
                         String property)
                  throws UtilsException

Throws:

UtilsException

Method Detail

get

public Object get(IPropertySource source,
                  boolean instantiateAll)
           throws UtilsException

Description copied from interface: IProperty

Introspects source to retrieve property value. If a nested property is null, tries if requested to instantiate all hierarchy. If this process fails, an exception is raised. If not requested, returns null.

Specified by:

get in interface IProperty

Parameters:

source - Source context to introspect.

instantiateAll - whether to try or not to instantiate null nested properties values.

Throws:

UtilsException

set

public Object set(IPropertySource target,
                  Object obj,
                  boolean instanciateNested)
           throws UtilsException

Description copied from interface: IProperty

Introspects target to set property value. Tries to instantiate null nested properties if requested. If it fails, an exception is raised. If not requested, an exception is directly raised in case of null nested property.

Specified by:

set in interface IProperty

Parameters:

target - Source context to introspect.

obj - Value to set

instanciateNested - whether to try or not to instantiate null nested properties values.

Returns:

Real set value (after eventual cast)

Throws:

UtilsException

isReadable

public boolean isReadable(IPropertySource source)
                   throws UtilsException

Description copied from interface: IProperty

Tries to detect if the property will be able to be read in theory, knowing the argument type to use. Might be based on a real bean or only on a type. When undefined, returns true, so that real case will be detected at runtime.

Specified by:

isReadable in interface IProperty

Parameters:

source - Source context to introspect.

Throws:

UtilsException

isWriteable

public boolean isWriteable(IPropertySource target)
                    throws UtilsException

Description copied from interface: IProperty

Tries to detect if the property will be able to be written in theory, knowing the argument type to use. Might be based on a real bean or only on a type. When undefined, returns true, so that real case will be detected at runtime.

Specified by:

isWriteable in interface IProperty

Parameters:

target - Source context to introspect.

Throws:

UtilsException

getType

public Class<?> getType(IPropertySource source)
                 throws UtilsException

Description copied from interface: IProperty

Tries to detect if the type of the property, knowing the argument type to use. If impossible, returns null.

Specified by:

getType in interface IProperty

Parameters:

source - Source context to introspect.

Throws:

UtilsException

getGenericCollectionType

public Class<?> getGenericCollectionType(IPropertySource source)
                                  throws UtilsException

Description copied from interface: IProperty

Tries to detect if the generic type of the property if the type is a Collection, knowing the argument type to use. If impossible, returns null.

Specified by:

getGenericCollectionType in interface IProperty

Parameters:

source - Source context to introspect.

Throws:

UtilsException

getGenericMapKeyType

public Class<?> getGenericMapKeyType(IPropertySource source)
                              throws UtilsException

Description copied from interface: IProperty

Tries to detect if the generic key type of the property if the type is a Map, knowing the argument type to use. If impossible, returns null.

Specified by:

getGenericMapKeyType in interface IProperty

Parameters:

source - Source context to introspect.

Throws:

UtilsException

getGenericMapValueType

public Class<?> getGenericMapValueType(IPropertySource source)
                                throws UtilsException

Description copied from interface: IProperty

Tries to detect if the generic value type of the property if the type is a Map, knowing the argument type to use. If impossible, returns null.

Specified by:

getGenericMapValueType in interface IProperty

Parameters:

source - Source context to introspect.

Throws:

UtilsException

getGenericTypes

public Class<?>[] getGenericTypes(IPropertySource source)
                           throws UtilsException

Description copied from interface: IProperty

Tries to detect if the parameterized types of the property, whatever its type is, knowing the argument type to use. If impossible, returns null.

Specified by:

getGenericTypes in interface IProperty

Parameters:

source - Source context to introspect.

Throws:

UtilsException

isVar

public boolean isVar()

Description copied from interface: IProperty2

This property is an access to local or global variable.

Specified by:

isVar in interface IProperty2

isLocalVar

public boolean isLocalVar()

Description copied from interface: IProperty2

This property is an access to local variable.
If a variable is accessed for retrieving key or index of a Map or Collection, this method should returns false.

Specified by:

isLocalVar in interface IProperty2

isGlobalVar

public boolean isGlobalVar()

Description copied from interface: IProperty2

This property is an access to global variable.
If a variable is accessed for retrieving key or index of a Map or Collection, this method should returns false.

Specified by:

isGlobalVar in interface IProperty2

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

optimize

public void optimize(ICompilationContext ctxt,
                     IPropertySource source)
              throws MRuleValidationException

Description copied from interface: IProperty2

Allows to optimize access if target type is known.

Specified by:

optimize in interface IProperty2

Parameters:

ctxt - Compilation context

source - Target type.

Throws:

MRuleValidationException

parentWasRegistered

public void parentWasRegistered(ICompilationContext ctxt,
                                IAddon parent)
                         throws MRuleValidationException

Description copied from interface: IProperty2

Notifies this property that the owner has been registered in compilation context.
As global variables are Addons, they must be also registered.

Specified by:

parentWasRegistered in interface IProperty2

Throws:

MRuleValidationException