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