RenderKitConfigHandler.java

/*
 * 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 com.sun.faces.application.annotation;

import java.lang.annotation.Annotation;
import java.util.Collection;
import java.util.Collections;
import java.util.ArrayList;
import java.util.Map;
import java.util.HashMap;

import javax.faces.context.FacesContext;
import javax.faces.render.ClientBehaviorRenderer;
import javax.faces.render.FacesBehaviorRenderer;
import javax.faces.render.FacesRenderer;
import javax.faces.render.RenderKitFactory;
import javax.faces.render.RenderKit;
import javax.faces.render.Renderer;
import javax.faces.FactoryFinder;
import javax.faces.FacesException;

/**
 * <p> <code>ConfigAnnotationHandler</code> {@link FacesRenderer} annotated classes.</p>
 */
public class RenderKitConfigHandler implements ConfigAnnotationHandler {

    private static final Collection<Class<? extends Annotation>> HANDLES;

    static {
        Collection<Class<? extends Annotation>> handles =
              new ArrayList<>(2);
        handles.add(FacesRenderer.class);
        handles.add(FacesBehaviorRenderer.class);
        HANDLES = Collections.unmodifiableCollection(handles);
    }

    Map<Class<?>, Annotation> annotatedRenderers;

    // ------------------------------------- Methods from ComponentConfigHandler


    /**
     * @see com.sun.faces.application.annotation.ConfigAnnotationHandler#getHandledAnnotations()
     */
    @Override
    public Collection<Class<? extends Annotation>> getHandledAnnotations() {

        return HANDLES;

    }


    /**
     * @see com.sun.faces.application.annotation.ConfigAnnotationHandler#collect(Class, java.lang.annotation.Annotation)
     */
    @Override
    public void collect(Class<?> target, Annotation annotation) {

        if (annotatedRenderers == null) {
            annotatedRenderers = new HashMap<>();
        }
        annotatedRenderers.put(target,  annotation);

    }


    /**
     * @see com.sun.faces.application.annotation.ConfigAnnotationHandler#push(javax.faces.context.FacesContext)
     */
    @Override
    public void push(FacesContext ctx) {


        if (annotatedRenderers != null) {
            RenderKitFactory rkf = (RenderKitFactory) FactoryFinder
            .getFactory(FactoryFinder.RENDER_KIT_FACTORY);
			for (Map.Entry<Class<?>, Annotation> entry : annotatedRenderers
					.entrySet()) {
				Class<?> rClass = entry.getKey();
				if (entry.getValue() instanceof FacesRenderer) {
					FacesRenderer ra = (FacesRenderer) entry.getValue();
					try {
						RenderKit rk = rkf.getRenderKit(ctx, ra.renderKitId());
						if (rk == null) {
							throw new IllegalStateException(
									"Error processing annotated Renderer "
											+ ra.toString()
											+ " on class "
											+ rClass.getName()
											+ ".  Unable to find specified RenderKit.");
						}
						rk.addRenderer(ra.componentFamily(), ra.rendererType(),
								(Renderer) rClass.newInstance());
					} catch (IllegalStateException | InstantiationException | IllegalAccessException e) {
						throw new FacesException(e);
					}
				} else if (entry.getValue() instanceof FacesBehaviorRenderer) {
					FacesBehaviorRenderer bra = (FacesBehaviorRenderer) entry
							.getValue();
					try {
						RenderKit rk = rkf.getRenderKit(ctx, bra.renderKitId());
						if (rk == null) {
							throw new IllegalStateException(
									"Error processing annotated ClientBehaviorRenderer "
											+ bra.toString()
											+ " on class "
											+ rClass.getName()
											+ ".  Unable to find specified RenderKit.");
						}
						rk.addClientBehaviorRenderer(bra.rendererType(),
								(ClientBehaviorRenderer) rClass.newInstance());
					} catch (IllegalStateException | InstantiationException | IllegalAccessException e) {
						throw new FacesException(e);
					}
				}
			}
		}

    }

}