javax.faces.application.ResourceDependency Maven / Gradle / Ivy

/*
 * 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.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.
 */

package javax.faces.application;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.lang.annotation.Inherited;
import java.lang.annotation.Repeatable;


/**
 * Instances of {@link
 * javax.faces.component.UIComponent} or {@link
 * javax.faces.render.Renderer} that have this annotation (or {@link
 * ResourceDependencies} attached at the class level will automatically
 * have a resource dependency added so that the named resource will be
 * present in user agent's view of the UIViewRoot in which
 * this component or renderer is used.
 * 
 * 
 * 
 * The default implementation must support attaching this annotation
 * to {@link javax.faces.component.UIComponent} or {@link
 * javax.faces.render.Renderer} classes.  In both cases, the event that
 * precipitates the processing of this annotation is the insertion of a
 * UIComponent instance into the view hierarchy on an
 * initial request for a view.  When that event happens, the following
 * action must be taken.  

 * 
 *  If this annotation is not present on the class in question, no action
 * must be taken.  
 *
 * Create a {@link javax.faces.component.UIOutput} instance by passing
 * javax.faces.Output. to {@link Application#createComponent(java.lang.String)}.
 *
 * Get the annotation instance from the class and obtain the values of
 * the name, library, and target
 * attributes.
 *
 * If library is the empty string, let library be
 * null.
 *
 * If target is the empty string, let target be
 * null.
 *
 * Obtain the renderer-type for the resource name by
 * passing name to {@link ResourceHandler#getRendererTypeForResourceName}.
 *
 * Call setRendererType on the UIOutput
 * instance, passing the renderer-type.
 *
 * Obtain the Map of attributes from the
 * UIOutput component by calling {@link javax.faces.component.UIComponent#getAttributes}.
 *
 * Store the name into the attributes Map under the
 * key "name".
 *
 * If library is non-null, store it under the key
 * "library".
 *
 * If target is non-null, store it under the key
 * "target". 
 *
 * Otherwise, if target is null, call {@link
 * javax.faces.component.UIViewRoot#addComponentResource(javax.faces.context.FacesContext,
 * javax.faces.component.UIComponent)}, passing the UIOutput
 * instance as the second argument.
 * 

 * Example:


  @ResourceDependency(library="corporate", name="colorAndMedia.css"),



 * 
 *
 * @since 2.0
 */
@Retention(value = RetentionPolicy.RUNTIME)
@Target(value = ElementType.TYPE)
@Inherited
@Repeatable(ResourceDependencies.class)
public @interface ResourceDependency {

    /**
     * The resourceName of the
     * resource pointed to by this ResourceDependency.  It
     * is valid to have EL Expressions in the value of this attribute,
     * as long as the expression resolves to an instance of the expected
     * type.
     * 
     * @return the name.
     */
    public String name();

    /**
     * The libraryName in which
     * the resource pointed to by this ResourceDependency
     * resides.  If not specified, defaults to the empty string.  It is
     * valid to have EL Expressions in the value of this attribute, as
     * long as the expression resolves to an instance of the expected
     * type.
     * 
     * @return the library.
     */
    public String library() default "";

    /**
     * The value given for this attribute
     * will be passed as the "target" argument to {@link
     * javax.faces.component.UIViewRoot#addComponentResource(javax.faces.context.FacesContext,
     * javax.faces.component.UIComponent, java.lang.String)}.  If this
     * attribute is specified, {@link
     * javax.faces.component.UIViewRoot#addComponentResource(javax.faces.context.FacesContext,javax.faces.component.UIComponent)}
     * must be called instead, as described above.  It is valid to have
     * EL Expressions in the value of this attribute, as long as the
     * expression resolves to an instance of the expected type.
     * 
     * @return the target.
     */
    public String target() default "";

}