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

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

Jakarta Faces defines an MVC framework for building user interfaces for web applications, including UI components, state management, event handing, input validation, page navigation, and support for internationalization and accessibility.

There is a newer version: 4.1.0

Show newest version

/*
 * 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;

/**
 * 
 * A mutable set of rules to be used in auto-wiring state to a particular object instance. Rules assigned to this object
 * will be composed into a single Metadata instance which will encapsulate the ruleset.
 * 
 *
 * @since 2.0
 */
public abstract class MetaRuleset {

    /**
     * 
     * Customize this MetaRuleset instance to advise it to ignore the attribute named by the
     * attribute argument, returning this.
     * 
     *
     * @param attribute the name of the attribute to ignore.
     * @return the MetaRuleset with the given attribute ignored.
     * @since 2.0
     */
    public abstract MetaRuleset ignore(String attribute);

    /**
     * 
     * Customize this MetaRuleset instance to advise it to ignore all attributes, returning this.
     * 
     *
     * @return the ignoreAll MetaRuleset.
     * @since 2.0
     */
    public abstract MetaRuleset ignoreAll();

    /**
     * 
     * Customize this MetaRuleset by removing the attribute named by argument attribute and
     * re-adding it under the name given by the argument property, returning this.
     * 
     *
     * @param attribute the attribute to remove.
     * @param property the property to add.
     * @return the aliased MetaRuleSet.
     * @since 2.0
     */
    public abstract MetaRuleset alias(String attribute, String property);

    /**
     * 
     * Add another {@link Metadata} to this ruleset, returning this.
     * 
     *
     * @param metadata the {@link Metadata} to add.
     * @return the {@link MetaRuleset} with the {@link Metadata} added.
     * @since 2.0
     */
    public abstract MetaRuleset add(Metadata metadata);

    /**
     * 
     * Add another {@link MetaRule} to this ruleset, returning this.
     * 
     *
     * @param rule the rule to add.
     * @return the {@link MetaRuleset} with the {@link MetaRule} added.
     * @since 2.0
     */
    public abstract MetaRuleset addRule(MetaRule rule);

    /**
     * 
     * Take actions to apply the rule.
     * 
     *
     * @return the Metadata with the MetaRuleSet applied.
     */
    public abstract Metadata finish();
}