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

/*
 * Copyright (c) 1997, 2020 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;

/**
 * 
 * There are concrete subclasses within the implementation that map concepts in the Facelet VDL page to Jakarta Server
 * Faces Java API calls the appropriate instances. For example, the “validator” attribute on an
 * input component is specified to point to a MethodExpression that references a method that performs the
 * validation. There is a concrete subclass of Metadata to perform this action when that attribute appears
 * in a Facelet VDL page.
 * 
 *
 * @since 2.0
 */
public abstract class Metadata {

    /**
     * 
     * Take the action prescribed in the Jakarta Faces Specification for this particular VDL element attribute.
     * 
     *
     * @param ctx The FaceletContext for this request.
     * @param instance The instance from the Jakarta Faces Java API on which the action should be taken. For example,
     * an instance of {@link jakarta.faces.component.EditableValueHolder}.
     */
    public abstract void applyMetadata(FaceletContext ctx, Object instance);
}