1   /*
    2    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
    3    * 
    4    * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
    5    * 
    6    * The contents of this file are subject to the terms of either the GNU
    7    * General Public License Version 2 only ("GPL") or the Common Development
    8    * and Distribution License("CDDL") (collectively, the "License").  You
    9    * may not use this file except in compliance with the License. You can obtain
   10    * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
   11    * or glassfish/bootstrap/legal/LICENSE.txt.  See the License for the specific
   12    * language governing permissions and limitations under the License.
   13    * 
   14    * When distributing the software, include this License Header Notice in each
   15    * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
   16    * Sun designates this particular file as subject to the "Classpath" exception
   17    * as provided by Sun in the GPL Version 2 section of the License file that
   18    * accompanied this code.  If applicable, add the following below the License
   19    * Header, with the fields enclosed by brackets [] replaced by your own
   20    * identifying information: "Portions Copyrighted [year]
   21    * [name of copyright owner]"
   22    * 
   23    * Contributor(s):
   24    * 
   25    * If you wish your version of this file to be governed by only the CDDL or
   26    * only the GPL Version 2, indicate your decision by adding "[Contributor]
   27    * elects to include this software in this distribution under the [CDDL or GPL
   28    * Version 2] license."  If you don't indicate a single choice of license, a
   29    * recipient has the option to distribute your version of this file under
   30    * either the CDDL, the GPL Version 2 or to extend the choice of license to
   31    * its licensees as provided above.  However, if you add GPL Version 2 code
   32    * and therefore, elected the GPL Version 2 license, then the option applies
   33    * only if the new code is made subject to such option by the copyright
   34    * holder.
   35    */
   36   
   37   package javax.faces.component;
   38   
   39   import javax.faces.context.FacesContext;
   40   
   41   /**
   42    * <p class="changed_added_2_0"><strong>UniqueIdVendor</strong> is an
   43    * interface implemented by <code>UIComponents</code> that also
   44    * implement {@link NamingContainer} so that they can provide unique ids
   45    * based on their own clientId.  This will reduce the amount of id
   46    * generation variance between different renderings of the same view and
   47    * is helpful for improved state saving.</p>
   48    *
   49    * @since 2.0
   50    */
   51   public interface UniqueIdVendor {
   52   
   53   
   54       /**<p>Generate an identifier for a component. The identifier
   55        * will be prefixed with UNIQUE_ID_PREFIX, and will be unique
   56        * within this component-container. Optionally, a unique seed value can
   57        * be supplied by component creators which should be
   58        * included in the generated unique id.</p>
   59        *
   60        * @param context FacesContext
   61        * @param seed an optional seed value - e.g. based on the position of the component in the VDL-template
   62        * @return a unique-id in this component-container
   63        */
   64       public String createUniqueId(FacesContext context, String seed);
   65   
   66   }