rendererdefinition.java

Please read your package and describe it at least 40 bytes in English. System will automatically de

/*
 * Copyright 2002-2004 the original author or authors.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package de.mindmatters.faces.spring.factory.xml;

import javax.faces.render.Renderer;

/**
 * A <strong>RendererDefinition</strong> encapsulates and describes a
 * {@link Renderer} instance. Description (e.g. component-family, renderer-type
 * etc.) is needed for registration purposes.
 * 
 * @author Andreas Kuhrwahl
 * 
 */
public final class RendererDefinition {

    /** The {@link Renderer} instance. */
    private final Renderer renderer;

    /** The renderer description. */
    private final String rendererType, componentFamily, renderKitId;

    /**
     * Creates a definition with the given {@link Renderer}
     * <code>renderer</code> and other describing properties.
     * 
     * @param componentFamily
     *            the component-family for which the renderer renders
     * @param rendererType
     *            the renderer type
     * @param renderer
     *            the {@link Renderer}
     * @param renderKitId
     *            the render-kit-id
     */
    public RendererDefinition(final String componentFamily,
            final String rendererType, final Renderer renderer,
            final String renderKitId) {
        super();
        this.componentFamily = componentFamily;
        this.rendererType = rendererType;
        this.renderer = renderer;
        this.renderKitId = renderKitId;
    }

    /**
     * @return the component-family for which the renderer renders
     */
    public String getComponentFamily() {
        return componentFamily;
    }

    /**
     * @return the encapsulated {@link Renderer}
     */
    public Renderer getRenderer() {
        return renderer;
    }

    /**
     * @return the type of the encapsulated {@link Renderer}
     */
    public String getRendererType() {
        return rendererType;
    }

    /**
     * @return the id of the {@link javax.faces.render.RenderKit} the
     *         encapsulated {@link Renderer} will be registered for
     */
    public String getRenderKitId() {
        return renderKitId;
    }

}