jakarta.el.BeanNameELResolver Maven / Gradle / Ivy
/*
* Copyright (c) 2012, 2021 Oracle and/or its affiliates and others.
* All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package jakarta.el;
import java.beans.FeatureDescriptor;
import java.util.Iterator;
/**
*
* An ELResolver for resolving user or container managed beans.
*
*
* A {@link BeanNameResolver} is required for its proper operation. The following example creates an
* ELResolver that resolves the name "bean" to an instance of MyBean.
*
*
*
* ELResovler elr = new BeanNameELResolver(new BeanNameResolver {
* public boolean isNameResolved(String beanName) {
* return "bean".equals(beanName);
* }
* public Object getBean(String beanName) {
* return "bean".equals(beanName)? new MyBean(): null;
* }
* });
*
*
*
* @since Jakarta Expression Language 3.0
*/
public class BeanNameELResolver extends ELResolver {
private BeanNameResolver beanNameResolver;
/**
* Constructor
*
* @param beanNameResolver The {@link BeanNameResolver} that resolves a bean name.
*/
public BeanNameELResolver(BeanNameResolver beanNameResolver) {
this.beanNameResolver = beanNameResolver;
}
/**
* If the base object is null and the property is a name that is resolvable by the BeanNameResolver,
* returns the value resolved by the BeanNameResolver.
*
*
* If name is resolved by the BeanNameResolver, 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.
*
*
* @param context The context of this evaluation.
* @param base null
* @param property The name of the bean.
* @return If the propertyResolved property of ELContext was set to true, then
* the value of the bean with the given name. Otherwise, undefined.
* @throws NullPointerException if context is null.
* @throws ELException if an exception was thrown while performing the property or variable resolution. The thrown
* exception must be included as the cause property of this exception, if available.
*/
@Override
public Object getValue(ELContext context, Object base, Object property) {
if (context == null) {
throw new NullPointerException();
}
if (base == null && property instanceof String) {
if (beanNameResolver.isNameResolved((String) property)) {
context.setPropertyResolved(base, property);
return beanNameResolver.getBean((String) property);
}
}
return null;
}
/**
* If the base is null and the property is a name that is resolvable by the BeanNameResolver, the bean in the
* BeanNameResolver is set to the given value.
*
*
* If the name is resolvable by the BeanNameResolver, or if the BeanNameResolver allows creating a new bean, the
* propertyResolved property of the ELContext object must be set to true by the
* resolver, before returning. If this property is not true after this method is called, the caller can
* safely assume no value has been set.
*
*
* @param context The context of this evaluation.
* @param base null
* @param property The name of the bean
* @param value The value to set the bean with the given name to.
* @throws NullPointerException if context is null
* @throws PropertyNotWritableException if the BeanNameResolver does not allow the bean to be modified.
* @throws ELException if an exception was thrown while attempting to set the bean with the given name. The thrown
* exception must be included as the cause property of this exception, if available.
*/
@Override
public void setValue(ELContext context, Object base, Object property, Object value) {
if (context == null) {
throw new NullPointerException();
}
if (base == null && property instanceof String) {
String beanName = (String) property;
if (beanNameResolver.isNameResolved(beanName) || beanNameResolver.canCreateBean(beanName)) {
beanNameResolver.setBeanValue(beanName, value);
context.setPropertyResolved(base, property);
}
}
}
/**
* If the base is null and the property is a name resolvable by the BeanNameResolver, return the type of the bean.
*
*
* If the name is resolvable by the BeanNameResolver, the propertyResolved property of the
* ELContext object must be set to true by the resolver, before returning. If this property is
* not true after this method is called, the caller can safely assume no value has been set.
*
*
* @param context The context of this evaluation.
* @param base null
* @param property The name of the bean.
* @return If the propertyResolved property of ELContext was set to true and
* the associated BeanNameResolver is not read-only then the type of the bean with the given name. If the given
* bean name was resolved but the associated BeanNameResolver is read-only then {@code null}. Otherwise, undefined.
* @throws NullPointerException if context is null.
* @throws ELException if an exception was thrown while performing the property or variable resolution. The thrown
* exception must be included as the cause property of this exception, if available.
*/
@Override
public Class getType(ELContext context, Object base, Object property) {
if (context == null) {
throw new NullPointerException();
}
if (base == null && property instanceof String) {
if (beanNameResolver.isNameResolved((String) property)) {
context.setPropertyResolved(true);
/*
* No resolver level isReadOnly property for this resolver
*/
if (beanNameResolver.isReadOnly((String) property)) {
return null;
}
return beanNameResolver.getBean((String) property).getClass();
}
}
return null;
}
/**
* If the base is null and the property is a name resolvable by the BeanNameResolver, attempts to determine if the bean
* is writable.
*
*
* If the name is resolvable by the BeanNameResolver, the propertyResolved property of the
* ELContext object must be set to true by the resolver, before returning. If this property is
* not true after this method is called, the caller can safely assume no value has been set.
*
*
* @param context The context of this evaluation.
* @param base null
* @param property The name of the bean.
* @return If the propertyResolved property of ELContext was set to true, then
* true if the property is read-only or false if not; otherwise undefined.
* @throws NullPointerException if context is null.
* @throws ELException if an exception was thrown while performing the property or variable resolution. The thrown
* exception must be included as the cause property of this exception, if available.
*/
@Override
public boolean isReadOnly(ELContext context, Object base, Object property) {
if (context == null) {
throw new NullPointerException();
}
if (base == null && property instanceof String) {
if (beanNameResolver.isNameResolved((String) property)) {
context.setPropertyResolved(true);
return beanNameResolver.isReadOnly((String) property);
}
}
return false;
}
/**
* Always returns null, since there is no reason to iterate through a list of one element: bean name.
*
* @param context The context of this evaluation.
* @param base null.
* @return null.
*
* @deprecated This method will be removed without replacement in EL 6.0
*/
@Deprecated(forRemoval = true, since = "5.0")
@Override
public Iterator getFeatureDescriptors(ELContext context, Object base) {
return null;
}
/**
* Always returns String.class, since a bean name is a String.
*
* @param context The context of this evaluation.
* @param base null.
* @return String.class.
*/
@Override
public Class getCommonPropertyType(ELContext context, Object base) {
return String.class;
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy