org.omnifaces.facesconfigparser.digester.beans.AttributeHolder Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 1997, 2018 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package org.omnifaces.facesconfigparser.digester.beans;

/**
 * 
 * Interface denoting a configuration bean that stores a named collection of attributes.
 * 
 */

public interface AttributeHolder {

    // ----------------------------------------------------------------- Methods

    /**
     * 
     * Add the specified attribute descriptor, replacing any existing descriptor for this attribute name.
     * 
     *
     * @param descriptor Descriptor to be added
     */
    public void addAttribute(AttributeBean descriptor);

    /**
     * 
     * Return the attribute descriptor for the specified attribute name, if any; otherwise, return null.
     * 
     *
     * @param name Name of the attribute for which to retrieve a descriptor
     * @return the attribute descriptor
     */
    public AttributeBean getAttribute(String name);

    /**
     * 
     * Return the descriptors of all attributes for which descriptors have been registered, or an empty array if none have
     * been registered.
     * 
     * 
     * @return the descriptors of all attributes
     */
    public AttributeBean[] getAttributes();

    /**
     * 
     * Deregister the specified attribute descriptor, if it is registered.
     * 
     *
     * @param descriptor Descriptor to be removed
     */
    public void removeAttribute(AttributeBean descriptor);

}