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

javax.faces.convert.FacesConverter Maven / Gradle / Ivy

Go to download

This is the master POM file for Oracle's Implementation of the JSF 2.2 Specification.

There is a newer version: 2.4.0
Show 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.
 */

package javax.faces.convert;

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;

/**
 * 

The presence of this annotation * on a class automatically registers the class with the runtime as a * {@link Converter}. The value of the {@link #value} attribute is * taken to be converter-id, the value of the {@link #forClass} * attribute is taken to be converter-for-class and the fully * qualified class name of the class to which this annotation is * attached is taken to be the converter-class. The * implementation must guarantee that for each class annotated with * FacesConverter, found with the algorithm in section * JSF.11.5, the proper variant of * Application.addConverter() is called. If * converter-id is not the empty string, {@link * javax.faces.application.Application#addConverter(java.lang.String,java.lang.String)} * is called, passing the derived converter-id as the first * argument and the derived converter-class as the second * argument. If converter-id is the empty string, {@link * javax.faces.application.Application#addConverter(java.lang.Class,java.lang.String)} * is called, passing the converter-for-class as the first * argument and the derived converter-class as the second * argument. The implementation must guarantee that all such calls to * addConverter() happen during application startup time * and before any requests are serviced.

*
*

The preceding text contains an important * subtlety which application users should understand. It is not * possible to use a single {@code @FacesConverter} annotation to * register a single {@code Converter} implementation both in the {@code * by-class} and the {@code by-converter-id} data structures. One way * to achieve this result is to put the actual converter logic in an * abstract base class, without a {@code @FacesConverter} annotation, * and derive two sub-classes, each with a {@code @FacesConverter} * annotation. One sub-class has a {@code value} attribute but no * {@code forClass} attribute, and the other sub-class has the converse.

*

Please see the ViewDeclarationLanguage documentation for {@code * } for another important subtlety regarding * converters and collections.

*
* */ @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.TYPE) @Inherited public @interface FacesConverter { /** *

The value of this annotation * attribute is taken to be the converter-id with which * instances of this class of converter can be instantiated by * calling {@link * javax.faces.application.Application#createConverter(java.lang.String)}.

*/ String value() default ""; /** *

The value of this annotation * attribute is taken to be the converter-for-class with * which instances of this class of converter can be instantiated by * calling {@link * javax.faces.application.Application#createConverter(java.lang.Class)}.

*/ Class forClass() default Object.class; }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy