javax.faces.view.facelets.MetaRule Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jboss-jsf-api_2.2_spec Show documentation
JSR-000344: JavaServer(TM) Faces 2.2 API
The newest version!
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2010 Oracle and/or its affiliates. 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_1_1.html
 * or packager/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 packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [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.
 *
 *
 * This file incorporates work covered by the following copyright and
 * permission notice:
 *
 * Copyright 2005-2007 The Apache Software Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package javax.faces.view.facelets;


/**
 * The root class of the abstraction that
 * dictates how attributes on a markup element in a Facelets VDL page
 * are wired to the JSF API object instance associated with that
 * element.  The single method on this interface, {@link #applyRule},
 * returns an encapsulation of the behavior that actually does the work
 * of handling the attribute and its value.  There are implementations of
 * specific concrete subclasses of this class for all the basic kinds of
 * elements that appear in Facelets VDL pages: components,
 * non-components, and attached objects.
 *
 * 

 * For example, consider this markup:

<h:inputText value="#{user.userid}" 
                valueChangeListener="#{user.newUserId}" />

 * Two MetaRule instances are involved in this example.

 * 
 *
 * The first has
 * an applyRule() method that returns a {@link Metadata}
 * instance that, when its applyMetada() method is called,
 * dictates how the "value" attribute is processed: calling {@link
 * javax.faces.component.UIComponent#setValueExpression} on the
 * UIComponent instance associated with the
 * <h:inputText> element.

 * The second has an applyRule() method that returns
 * a {@link Metadata} instance that, when its
 * applyMetadata() method is called, dictates how the
 * "valueChangeListener" attribute is processed: calling {@link
 * javax.faces.component.EditableValueHolder#addValueChangeListener}.

 * 

 * 
 *
 * @since 2.0
 */
public abstract class MetaRule {

    
    /**
     * Return an abstraction that takes
     * appropriate action given the kind of rule represented by the
     * argument name, in the context of this particular
     * concrete subclass of MetaRule.  The abstraction must
     * encapsulate the value from the argument
     * attribute.
     * @since 2.0
     * @param name the name for this rule.  This will generally be the
     * name of a tag attribute in the VDL.
     * @param attribute the name/value pair for this attribute on this
     * particular instance of an element in the page.
     * @param meta the MetadataTarged that can be used to
     * discern what kind of action to encapsulate within the abstraction
     * to be returned.

     */
    public abstract Metadata applyRule(String name, TagAttribute attribute,
            MetadataTarget meta);

}