com.massa.util.property

Class PropertyCompiler

java.lang.Object

com.massa.util.property.PropertyCompiler

All Implemented Interfaces:

IPropertyCompiler

Direct Known Subclasses:

PropertyCompiler.SecurePropertyCompiler, PropertyCompiler2

public class PropertyCompiler
extends Object
implements IPropertyCompiler

Utility class to compile properties. General usage:
IProperty prop = PropertyCompiler.COMPILER.compile("prop.subProp.finalProp");
This is a thread safe implementation of IPropertyCompiler.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	PropertyCompiler.DefaultPropertyFactory
protected static class	PropertyCompiler.IPropertyComponent Internal use only.
static interface	PropertyCompiler.IPropertyFactory Defines methods allowing to instantiate properties.
protected static class	PropertyCompiler.SecuredPropertyFactory
protected class	PropertyCompiler.SecurePropertyCompiler Internal use only.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PropertyCompiler() Declared as protected, as this compiler might be overridden to add some functionalities.

Method Summary

Modifier and Type	Method and Description
IProperty	compile(String property) Compiles a property into a compiled representation, with useCommonBeanUtilsSyntax to false.
IProperty	compile(String property, boolean useCommonBeanUtilsSyntax) Compiles a property into a compiled representation.
protected PropertyCompiler.IPropertyFactory	createPropertyFactory() Might be overridden to change secured PropertyCompiler.IPropertyFactory implementation.
static IPropertyCompiler	getInstance()
protected PropertyCompiler.IPropertyFactory	getPropertyFactory()
protected IPropertyCompiler	getSecureCompiler(MRulesUtilsSecurityManager securityManager) Might be overridden to change secured IPropertyCompiler implementation.
protected PropertyCompiler.IPropertyComponent	handleGetterSetterComponent(PropertyCompiler.IPropertyComponent prevComponent, String property, boolean useCommonBeanUtilsSyntax)
protected PropertyCompiler.IPropertyComponent	handleSimpleComponent(PropertyCompiler.IPropertyComponent prevComponent, String property, boolean useCommonBeanUtilsSyntax) Handles a simple property component, i.e. a single element of the List provided by splitIntoSimpleComponents(String).
protected PropertyCompiler.IPropertyComponent	handleStaticComponent(PropertyCompiler.IPropertyComponent prevComponent, String property, boolean useCommonBeanUtilsSyntax) parses a static access property (field or method).
protected PropertyCompiler.IPropertyComponent	handleStrictComponent(PropertyCompiler.IPropertyComponent prevComponent, String property, boolean useCommonBeanUtilsSyntax) parses a strict access property (field or method).
IProperty	secureCompile(String property) Compiles a property into a compiled representation, with useCommonBeanUtilsSyntax to false and checking against current default MRulesUtilsSecurityManager configuration if the operations performed by the compiled property are allowed.
IProperty	secureCompile(String property, MRulesUtilsSecurityManager securityManager) Compiles a property into a compiled representation, with useCommonBeanUtilsSyntax to false and checking against provider MRulesUtilsSecurityManager configuration if the operations performed by the compiled property are allowed.
protected List<String>	splitIntoSimpleComponents(String property) Splits the property into sub-components, splitting all "main" dots.

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyCompiler

protected PropertyCompiler()

Declared as protected, as this compiler might be overridden to add some functionalities.

Method Detail

getInstance

public static IPropertyCompiler getInstance()

Returns:

Default global instance.

compile

public IProperty compile(String property)
                  throws UtilsException

Description copied from interface: IPropertyCompiler

Compiles a property into a compiled representation, with useCommonBeanUtilsSyntax to false.
This representation is not created against a specific Class, but might be used with any compatible class.

Specified by:

compile in interface IPropertyCompiler

Throws:

UtilsException

secureCompile

public IProperty secureCompile(String property)
                        throws UtilsException

Description copied from interface: IPropertyCompiler

Compiles a property into a compiled representation, with useCommonBeanUtilsSyntax to false and checking against current default MRulesUtilsSecurityManager configuration if the operations performed by the compiled property are allowed.
This representation is not created against a specific Class, but might be used with any compatible class.

Specified by:

secureCompile in interface IPropertyCompiler

Throws:

UtilsException

secureCompile

public IProperty secureCompile(String property,
                               MRulesUtilsSecurityManager securityManager)
                        throws UtilsException

Description copied from interface: IPropertyCompiler

Compiles a property into a compiled representation, with useCommonBeanUtilsSyntax to false and checking against provider MRulesUtilsSecurityManager configuration if the operations performed by the compiled property are allowed.
This representation is not created against a specific Class, but might be used with any compatible class.

Specified by:

secureCompile in interface IPropertyCompiler

Throws:

UtilsException

compile

public IProperty compile(String property,
                         boolean useCommonBeanUtilsSyntax)
                  throws UtilsException

Description copied from interface: IPropertyCompiler

Compiles a property into a compiled representation.
This representation is not created against a specific Class, but might be used with any compatible class.
The parameter "useCommonBeanUtilsSyntax" allows to force usage of common beanutils syntax, i.e. it does not interpret index or key for mapped or indexed properties as variables, but always as constants. Direct methods or field accesses are not possible either.

Specified by:

compile in interface IPropertyCompiler

Throws:

UtilsException

handleSimpleComponent

protected PropertyCompiler.IPropertyComponent handleSimpleComponent(PropertyCompiler.IPropertyComponent prevComponent,
                                                                    String property,
                                                                    boolean useCommonBeanUtilsSyntax)
                                                             throws UtilsException

Handles a simple property component, i.e. a single element of the List provided by splitIntoSimpleComponents(String).
Basically routes between handleGetterSetterComponent(IPropertyComponent, String, boolean) and handleStrictComponent(IPropertyComponent, String, boolean)

Throws:

UtilsException

handleStaticComponent

protected PropertyCompiler.IPropertyComponent handleStaticComponent(PropertyCompiler.IPropertyComponent prevComponent,
                                                                    String property,
                                                                    boolean useCommonBeanUtilsSyntax)
                                                             throws UtilsException

parses a static access property (field or method).
Relies on handleStrictComponent(IPropertyComponent, String, boolean) to parse access part

Throws:

UtilsException

handleStrictComponent

protected PropertyCompiler.IPropertyComponent handleStrictComponent(PropertyCompiler.IPropertyComponent prevComponent,
                                                                    String property,
                                                                    boolean useCommonBeanUtilsSyntax)
                                                             throws UtilsException

parses a strict access property (field or method).

Throws:

UtilsException

handleGetterSetterComponent

protected PropertyCompiler.IPropertyComponent handleGetterSetterComponent(PropertyCompiler.IPropertyComponent prevComponent,
                                                                          String property,
                                                                          boolean useCommonBeanUtilsSyntax)
                                                                   throws UtilsException

Throws:

UtilsException

splitIntoSimpleComponents

protected List<String> splitIntoSimpleComponents(String property)
                                          throws UtilsException

Splits the property into sub-components, splitting all "main" dots.
Example : first.second[subFirst.subSecond].third gives [first ; second[subFirst.subSecond] ; third].

Throws:

UtilsException

getSecureCompiler

protected IPropertyCompiler getSecureCompiler(MRulesUtilsSecurityManager securityManager)

Might be overridden to change secured IPropertyCompiler implementation.

createPropertyFactory

protected PropertyCompiler.IPropertyFactory createPropertyFactory()

Might be overridden to change secured PropertyCompiler.IPropertyFactory implementation.

getPropertyFactory

protected PropertyCompiler.IPropertyFactory getPropertyFactory()