001package org.apache.maven.configuration;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *   http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022/**
023 * Unmarshals some textual configuration from the POM or similar into the properties of a bean. This component works
024 * similar to the way Maven configures plugins from the POM, i.e. some configuration like {@code <param>value</param>}
025 * is mapped to an equally named property of the bean and converted. The properties of the bean are supposed to either
026 * have a public setter or be backed by an equally named field (of any visibility).
027 * 
028 * @since 3.0
029 * @author Benjamin Bentmann
030 */
031public interface BeanConfigurator
032{
033
034    /**
035     * Performs the specified bean configuration.
036     * 
037     * @param request The configuration request that specifies the bean and the configuration to process, must not be
038     *            {@code null}.
039     * @throws BeanConfigurationException If the bean configuration could not be successfully processed.
040     */
041    void configureBean( BeanConfigurationRequest request )
042        throws BeanConfigurationException;
043
044}