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 * Preprocesses a value from a bean configuration before the bean configurator unmarshals it into a bean property. A
24 * common use case for such preprocessing is the evaluation of variables within the configuration value.
25 *
26 * @author Benjamin Bentmann
27 */
28 public interface BeanConfigurationValuePreprocessor
29 {
30
31 /**
32 * Preprocesses the specified bean configuration value. The optional type provided to this method is a hint (not a
33 * requirement) for the preprocessor to resolve the value to a compatible value or a (string) value than can be
34 * unmarshalled into that type. The preprocessor is not required to perform any type conversion but should rather
35 * filter out incompatible values from its result.
36 *
37 * @param value The configuration value to preprocess, must not be {@code null}.
38 * @param type The target type of the value, may be {@code null}.
39 * @return The processed configuration value or {@code null} if none.
40 * @throws BeanConfigurationException If an error occurred while preprocessing the value.
41 */
42 Object preprocessValue( String value, Class<?> type )
43 throws BeanConfigurationException;
44
45 }