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