All Downloads are FREE. Search and download functionalities are using the official Maven repository.

javax.faces.el.PropertyResolver Maven / Gradle / Ivy

Go to download

This is the master POM file for Sun's Implementation of the JSF 2.1 Specification.

There is a newer version: 2.2.20
Show newest version
/*
 * $Id: PropertyResolver.java,v 1.15 2007/04/27 22:00:08 ofung Exp $
 */

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 * 
 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 * 
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License. You can obtain
 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
 * or glassfish/bootstrap/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 * 
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
 * Sun designates this particular file as subject to the "Classpath" exception
 * as provided by Sun in the GPL Version 2 section of the License file that
 * accompanied this code.  If applicable, add the following below the License
 * Header, with the fields enclosed by brackets [] replaced by your own
 * identifying information: "Portions Copyrighted [year]
 * [name of copyright owner]"
 * 
 * Contributor(s):
 * 
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */


package javax.faces.el;


/**
 * 

PropertyResolver represents a pluggable mechanism * for accessing a "property" of an underlying Java object instance. * Different {@link PropertyResolver} implementations can support * property resolution on instances of different Java classes (such as * introspection-based access to properties of a JavaBeans component, or * get() and put() calls on a * java.util.Map instance).

*

All implementations must respect the rules for JavaBeans component, * java.util.Map, java.util.List and array * instances defined for each method but are allowed to add custom * semantics for other types.

* * @deprecated This has been replaced by {@link javax.el.ELResolver}. */ public abstract class PropertyResolver { /** *

Return the value of the specified property from the specified * base object.

*

For a bean base object, the property is coerced to a * String and used as the property name. * For all other base object types (e.g., a Map), the property is used * without any coercing.

* * @param base The base object whose property value is to be returned * @param property The property to be returned * @return The property value, or null if base * or property is null, or if the property * doesn't exist and the base object is a Map instance * * @throws EvaluationException if an exception is thrown while getting * the property value (the thrown exception must be included as the * cause property of this exception) * @throws PropertyNotFoundException if the specified property * for a bean base object does not exist or is not readable */ public abstract Object getValue(Object base, Object property) throws EvaluationException, PropertyNotFoundException; /** *

Return the value at the specified index of the specified * base object.

* * @param base The base object whose property value is to be returned * @param index The index of the value to return * @return The property value, or null if base * is null, or if the index is out of bounds for the base * object * * @throws EvaluationException if an exception is thrown while getting * the property value (the thrown exception must be included as the * cause property of this exception) * @throws PropertyNotFoundException if the index is out of * bounds or if base is null */ public abstract Object getValue(Object base, int index) throws EvaluationException, PropertyNotFoundException; /** *

Set the specified value of the specified property on * the specified base object.

*

For a bean base object, the property is coerced to a * String and used as the property name. * For all other base object types (e.g., a Map), the property is used * without any coercing.

* * @param base The base object whose property value is to be set * @param property The property to be set * @param value The value of the property to be set * * @throws EvaluationException if an exception is thrown while setting * the property value (the thrown exception must be included as the * cause property of this exception) * @throws PropertyNotFoundException if the specified bean base * object property does not exist or is not writeable, or if * base or name is null */ public abstract void setValue(Object base, Object property, Object value) throws EvaluationException, PropertyNotFoundException; /** *

Set the value at the specified index of the specified * base object.

* * @param base The base object whose property value is to be set * @param index The index of the value to set * @param value The value to be set * * @throws EvaluationException if an exception is thrown while setting * the property value (the thrown exception must be included as the * cause property of this exception) * @throws PropertyNotFoundException if the index is out of * bounds or if base is null */ public abstract void setValue(Object base, int index, Object value) throws EvaluationException, PropertyNotFoundException; /** *

Checks if the specified property is read-only.

*

For a bean base object, the property is coerced to a * String and used as the property name. * For all other base object types (e.g., a Map), the property is used * without any coercing.

* * @param base The base object whose property is to be analyzed * @param property The property to be analyzed * @return true if the specified property of the specified * base object is known to be immutable; otherwise false * * @throws EvaluationException if an exception is thrown while testing * the property (the thrown exception must be included as the * cause property of this exception) * @throws PropertyNotFoundException if the specified bean base * object property does not exist or if base or * property is null */ public abstract boolean isReadOnly(Object base, Object property) throws EvaluationException, PropertyNotFoundException; /** *

Checks if the specified index is read-only.

* * @param base The base object whose property is to be analyzed * @param index The index of the value whose type is to be returned * @return true if the value at the specified index of * the specified base object is known to be immutable; otherwise, * false * * @throws EvaluationException if an exception is thrown while testing * the property (the thrown exception must be included as the * cause property of this exception) * @throws PropertyNotFoundException if the index is out of * bounds or if base is null */ public abstract boolean isReadOnly(Object base, int index) throws EvaluationException, PropertyNotFoundException; /** *

Return the java.lang.Class representing the type * of the specified property. An instance of any Object of that * type my be set as the value of that property, as long as the * property is not read-only. The actual value of the property, if * non-null, is guaranteed to be an instance of this type, or an * instance of a subclass of this type. This method is also useful * for discovering the type of Objects that may be set as the value * of the property.

* *

For a bean base object, the property is coerced to a * String and used as the property name. For all other * base object types (e.g., a Map), the property is used without any * coercing.

* * @param base The base object whose property is to be analyzed * @param property The property to be analyzed * @return the java.lang.Class representing the type of * the specified property of the specified base object, if it can be * determined; otherwise null * * @throws EvaluationException if an exception is thrown while testing * the property (the thrown exception must be included as the * cause property of this exception) * @throws PropertyNotFoundException if the specified bean base * object property does not exist or if base or * property is null */ public abstract Class getType(Object base, Object property) throws EvaluationException, PropertyNotFoundException; /** *

Return the java.lang.Class representing the type of * the specified index.

* * @param base The base object whose property is to be analyzed * @param index The index of the value whose type is to be returned * @return The java.lang.Class representing the type of * value at the specified index of the specified base object, if it * can be determined; otherwise null * * @throws EvaluationException if an exception is thrown while testing * the property (the thrown exception must be included as the * cause property of this exception) * @throws PropertyNotFoundException if the index is out of * bounds or if base is null */ public abstract Class getType(Object base, int index) throws EvaluationException, PropertyNotFoundException; }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy