1   /*
    2    * $Id: Renderer.java,v 1.39.12.7 2008/04/17 18:51:29 edburns Exp $
    3    */
    4   
    5   /*
    6    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
    7    * 
    8    * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
    9    * 
   10    * The contents of this file are subject to the terms of either the GNU
   11    * General Public License Version 2 only ("GPL") or the Common Development
   12    * and Distribution License("CDDL") (collectively, the "License").  You
   13    * may not use this file except in compliance with the License. You can obtain
   14    * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
   15    * or glassfish/bootstrap/legal/LICENSE.txt.  See the License for the specific
   16    * language governing permissions and limitations under the License.
   17    * 
   18    * When distributing the software, include this License Header Notice in each
   19    * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
   20    * Sun designates this particular file as subject to the "Classpath" exception
   21    * as provided by Sun in the GPL Version 2 section of the License file that
   22    * accompanied this code.  If applicable, add the following below the License
   23    * Header, with the fields enclosed by brackets [] replaced by your own
   24    * identifying information: "Portions Copyrighted [year]
   25    * [name of copyright owner]"
   26    * 
   27    * Contributor(s):
   28    * 
   29    * If you wish your version of this file to be governed by only the CDDL or
   30    * only the GPL Version 2, indicate your decision by adding "[Contributor]
   31    * elects to include this software in this distribution under the [CDDL or GPL
   32    * Version 2] license."  If you don't indicate a single choice of license, a
   33    * recipient has the option to distribute your version of this file under
   34    * either the CDDL, the GPL Version 2 or to extend the choice of license to
   35    * its licensees as provided above.  However, if you add GPL Version 2 code
   36    * and therefore, elected the GPL Version 2 license, then the option applies
   37    * only if the new code is made subject to such option by the copyright
   38    * holder.
   39    */
   40   
   41   package javax.faces.component;
   42   
   43   import java.lang.annotation.ElementType;
   44   import java.lang.annotation.Retention;
   45   import java.lang.annotation.RetentionPolicy;
   46   import java.lang.annotation.Target;
   47   import java.lang.annotation.Inherited;
   48   
   49   
   50   /**
   51    * <p class="changed_added_2_0">The presence of this annotation on a
   52    * class automatically registers the class with the runtime as a {@link
   53    * UIComponent}.  The value of the {@link #value} attribute is taken to
   54    * be the <em>component-type</em> and the fully qualified class name of
   55    * the class to which this annotation is attached is taken to be the
   56    * <em>component-class</em>.  The implementation must guarantee that for
   57    * each class annotated with <code>FacesComponent</code>, found with the
   58    * scanning algorithm in section JSF.11.5, {@link
   59    * javax.faces.application.Application#addComponent(java.lang.String,java.lang.String)}
   60    * is called, passing the derived <em>component-type</em> as the first
   61    * argument and the derived <em>component-class</em> as the second
   62    * argument.  The implementation must guarantee that all such calls to
   63    * <code>addComponent()</code> happen during application startup time
   64    * and before any requests are serviced.</p>
   65   
   66    */ 
   67   
   68   @Retention(RetentionPolicy.RUNTIME)
   69   @Target(ElementType.TYPE)
   70   @Inherited
   71   public @interface FacesComponent {
   72   
   73       /**
   74        * <p class="changed_added_2_0">The value of this annotation
   75        * attribute is taken to be the <em>component-type</em> with which
   76        * instances of this class of component can be instantiated by
   77        * calling {@link
   78        * javax.faces.application.Application#createComponent(java.lang.String)}</p>
   79        */ 
   80   
   81       String value();
   82   
   83   
   84   }