jakarta.faces.view.facelets.CompositeFaceletHandler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jakarta.faces Show documentation

EE4J Compatible Implementation for Jakarta Faces API

The newest version!

/*
 * Copyright (c) 1997, 2021 Oracle and/or its affiliates. All rights reserved.
 * Copyright 2005-2007 The Apache Software Foundation
 *
 * 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 jakarta.faces.view.facelets;

import java.io.IOException;

import jakarta.faces.component.UIComponent;

/**
 * 
 * A FaceletHandler that is derived of 1 or more, inner FaceletHandlers. This class would be found if the next
 * FaceletHandler is structurally, a body with multiple child elements as defined in XML. This class enables the Facelet
 * runtime to traverse the tree of {@link FaceletHandler} instances built by the Facelets compiler.
 * 
 *
 */
public final class CompositeFaceletHandler implements FaceletHandler {

    private final FaceletHandler[] handlers;

    /**
     * Creates a new FaceletHandler out of the given inner FaceletHandlers.
     * @param handlers the inner FaceletHandlers.
     */
    public CompositeFaceletHandler(FaceletHandler[] handlers) {
        this.handlers = handlers;
    }

    /**
     * 
     * Calls apply on any child handlers.
     * 
     *
     * @param ctx the FaceletContext for this view execution
     *
     * @param parent the parent UIComponent of the component represented by this element instance.
     * @since 2.0
     */
    @Override
    public void apply(FaceletContext ctx, UIComponent parent) throws IOException {
        for (FaceletHandler childHandler : handlers) {
            childHandler.apply(ctx, parent);
        }
    }

    /**
     * 
     * Returns the array of child handlers contained by this handler.
     * 
     *
     * @return Returns the array of child handlers contained by this handler.
     */
    public FaceletHandler[] getHandlers() {
        return handlers;
    }
}