Package com.hubspot.jinjava.el.ext

Class JinjavaBeanELResolver

java.lang.Object

javax.el.ELResolver

com.hubspot.jinjava.el.ext.BeanELResolver

com.hubspot.jinjava.el.ext.JinjavaBeanELResolver

public class JinjavaBeanELResolver
extends BeanELResolver

BeanELResolver supporting snake case property names.

Nested Class Summary

Nested classes/interfaces inherited from class com.hubspot.jinjava.el.ext.BeanELResolver

BeanELResolver.BeanProperties, BeanELResolver.BeanProperty

Field Summary

Fields inherited from class javax.el.ELResolver

RESOLVABLE_AT_DESIGN_TIME, TYPE

Constructor Summary

Constructors

Constructor	Description
JinjavaBeanELResolver()	Creates a new read/write JinjavaBeanELResolver.
JinjavaBeanELResolver(boolean readOnly)	Creates a new JinjavaBeanELResolver whose read-only status is determined by the given parameter.

Method Summary

Modifier and Type	Method	Description
protected Method	findMethod(Object base, String name, Class<?>[] types, Object[] params, int paramCount)
Class<?>	getType(javax.el.ELContext context, Object base, Object property)	If the base object is not null, returns the most general acceptable type that can be set on this bean property.
Object	getValue(javax.el.ELContext context, Object base, Object property)	If the base object is not null, returns the current value of the given property on this bean.
Object	invoke(javax.el.ELContext context, Object base, Object method, Class<?>[] paramTypes, Object[] params)	If the base object is not null, invoke the method, with the given parameters on this bean.
boolean	isReadOnly(javax.el.ELContext context, Object base, Object property)	If the base object is not null, returns whether a call to BeanELResolver.setValue(ELContext, Object, Object, Object) will always fail.
protected boolean	isRestrictedClass(Object o)
void	setValue(javax.el.ELContext context, Object base, Object property, Object value)	If the base object is not null, attempts to set the value of the given property on this bean.

Methods inherited from class com.hubspot.jinjava.el.ext.BeanELResolver

coerceParams, findAccessibleMethod, getCommonPropertyType, getExpressionFactory, getFeatureDescriptors, getReadMethod

Methods inherited from class java.lang.Object

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

Constructor Detail

JinjavaBeanELResolver

public JinjavaBeanELResolver()

Creates a new read/write JinjavaBeanELResolver.

JinjavaBeanELResolver

public JinjavaBeanELResolver(boolean readOnly)

Creates a new JinjavaBeanELResolver whose read-only status is determined by the given parameter.

Method Detail

getType

public Class<?> getType(javax.el.ELContext context,
                        Object base,
                        Object property)

Description copied from class: BeanELResolver

If the base object is not null, returns the most general acceptable type that can be set on this bean property. If the base is not null, the propertyResolved property of the ELContext object must be set to true by this resolver, before returning. If this property is not true after this method is called, the caller should ignore the return value. The provided property will first be coerced to a String. If there is a BeanInfoProperty for this property and there were no errors retrieving it, the propertyType of the propertyDescriptor is returned. Otherwise, a PropertyNotFoundException is thrown.

Overrides:

getType in class BeanELResolver

Parameters:

context - The context of this evaluation.

base - The bean to analyze.

property - The name of the property to analyze. Will be coerced to a String.

Returns:

If the propertyResolved property of ELContext was set to true, then the most general acceptable type; otherwise undefined.

getValue

public Object getValue(javax.el.ELContext context,
                       Object base,
                       Object property)

Description copied from class: BeanELResolver

If the base object is not null, returns the current value of the given property on this bean. If the base is not null, the propertyResolved property of the ELContext object must be set to true by this resolver, before returning. If this property is not true after this method is called, the caller should ignore the return value. The provided property name will first be coerced to a String. If the property is a readable property of the base object, as per the JavaBeans specification, then return the result of the getter call. If the getter throws an exception, it is propagated to the caller. If the property is not found or is not readable, a PropertyNotFoundException is thrown.

Overrides:

getValue in class BeanELResolver

Parameters:

context - The context of this evaluation.

base - The bean to analyze.

property - The name of the property to analyze. Will be coerced to a String.

Returns:

If the propertyResolved property of ELContext was set to true, then the value of the given property. Otherwise, undefined.

isReadOnly

public boolean isReadOnly(javax.el.ELContext context,
                          Object base,
                          Object property)

Description copied from class: BeanELResolver

If the base object is not null, returns whether a call to BeanELResolver.setValue(ELContext, Object, Object, Object) will always fail. If the base is not null, the propertyResolved property of the ELContext object must be set to true by this resolver, before returning. If this property is not true after this method is called, the caller can safely assume no value was set.

Overrides:

isReadOnly in class BeanELResolver

Parameters:

context - The context of this evaluation.

base - The bean to analyze.

property - The name of the property to analyze. Will be coerced to a String.

Returns:

If the propertyResolved property of ELContext was set to true, then true if calling the setValue method will always fail or false if it is possible that such a call may succeed; otherwise undefined.

setValue

public void setValue(javax.el.ELContext context,
                     Object base,
                     Object property,
                     Object value)

Description copied from class: BeanELResolver

If the base object is not null, attempts to set the value of the given property on this bean. If the base is not null, the propertyResolved property of the ELContext object must be set to true by this resolver, before returning. If this property is not true after this method is called, the caller can safely assume no value was set. If this resolver was constructed in read-only mode, this method will always throw PropertyNotWritableException. The provided property name will first be coerced to a String. If property is a writable property of base (as per the JavaBeans Specification), the setter method is called (passing value). If the property exists but does not have a setter, then a PropertyNotFoundException is thrown. If the property does not exist, a PropertyNotFoundException is thrown.

Overrides:

setValue in class BeanELResolver

Parameters:

context - The context of this evaluation.

base - The bean to analyze.

property - The name of the property to analyze. Will be coerced to a String.

value - The value to be associated with the specified key.

invoke

public Object invoke(javax.el.ELContext context,
                     Object base,
                     Object method,
                     Class<?>[] paramTypes,
                     Object[] params)

Description copied from class: BeanELResolver

If the base object is not null, invoke the method, with the given parameters on this bean. The return value from the method is returned.

If the base is not null, the propertyResolved property of the ELContext object must be set to true by this resolver, before returning. If this property is not true after this method is called, the caller should ignore the return value.

The provided method object will first be coerced to a String. The methods in the bean is then examined and an attempt will be made to select one for invocation. If no suitable can be found, a MethodNotFoundException is thrown. If the given paramTypes is not null, select the method with the given name and parameter types. Else select the method with the given name that has the same number of parameters. If there are more than one such method, the method selection process is undefined. Else select the method with the given name that takes a variable number of arguments. Note the resolution for overloaded methods will likely be clarified in a future version of the spec. The provided parameters are coerced to the corresponding parameter types of the method, and the method is then invoked.

Overrides:

invoke in class BeanELResolver

Parameters:

context - The context of this evaluation.

base - The bean on which to invoke the method

method - The simple name of the method to invoke. Will be coerced to a String. If method is "<init>"or "<clinit>" a MethodNotFoundException is thrown.

paramTypes - An array of Class objects identifying the method's formal parameter types, in declared order. Use an empty array if the method has no parameters. Can be null, in which case the method's formal parameter types are assumed to be unknown.

params - The parameters to pass to the method, or null if no parameters.

Returns:

The result of the method invocation (null if the method has a void return type).

findMethod

protected Method findMethod(Object base,
                            String name,
                            Class<?>[] types,
                            Object[] params,
                            int paramCount)

Overrides:

findMethod in class BeanELResolver

isRestrictedClass

protected boolean isRestrictedClass(Object o)