001    /*
002     * JBoss DNA (http://www.jboss.org/dna)
003     * See the COPYRIGHT.txt file distributed with this work for information
004     * regarding copyright ownership.  Some portions may be licensed
005     * to Red Hat, Inc. under one or more contributor license agreements.
006     * See the AUTHORS.txt file in the distribution for a full listing of 
007     * individual contributors. 
008     *
009     * JBoss DNA is free software. Unless otherwise indicated, all code in JBoss DNA
010     * is licensed to you under the terms of the GNU Lesser General Public License as
011     * published by the Free Software Foundation; either version 2.1 of
012     * the License, or (at your option) any later version.
013     *
014     * JBoss DNA is distributed in the hope that it will be useful,
015     * but WITHOUT ANY WARRANTY; without even the implied warranty of
016     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
017     * Lesser General Public License for more details.
018     *
019     * You should have received a copy of the GNU Lesser General Public
020     * License along with this software; if not, write to the Free
021     * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
022     * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
023     */
024    package org.jboss.dna.common.component;
025    
026    /**
027     * The interface for a DNA component, which sequences nodes and their content to extract additional information from the
028     * information.
029     * <p>
030     * Implementations must provide a no-argument constructor.
031     * </p>
032     * @author Randall Hauch
033     * @param <T> the type of configuration
034     */
035    public interface Component<T extends ComponentConfig> {
036    
037        /**
038         * This method allows the implementation to initialize and configure itself using the supplied {@link ComponentConfig}
039         * information, and is called prior to any other class to this object. When this method is called, the implementation must
040         * maintain a reference to the supplied configuration (which should then be returned in {@link #getConfiguration()}.
041         * @param configuration the configuration for the component
042         */
043        void setConfiguration( T configuration );
044    
045        /**
046         * Return the configuration for this component, as supplied to the last {@link #setConfiguration(ComponentConfig)} invocation.
047         * @return the configuration, or null if not yet configured
048         */
049        T getConfiguration();
050    
051    }