View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.maven.configuration;
20  
21  /**
22   * Unmarshals some textual configuration from the POM or similar into the properties of a bean. This component works
23   * similar to the way Maven configures plugins from the POM, i.e. some configuration like {@code <param>value</param>}
24   * is mapped to an equally named property of the bean and converted. The properties of the bean are supposed to either
25   * have a public setter or be backed by an equally named field (of any visibility).
26   *
27   * @since 3.0
28   * @author Benjamin Bentmann
29   */
30  public interface BeanConfigurator {
31  
32      /**
33       * Performs the specified bean configuration.
34       *
35       * @param request The configuration request that specifies the bean and the configuration to process, must not be
36       *            {@code null}.
37       * @throws BeanConfigurationException If the bean configuration could not be successfully processed.
38       */
39      void configureBean(BeanConfigurationRequest request) throws BeanConfigurationException;
40  }