1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
|
package org.apache.maven.configuration;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/**
* A request to configure a bean from some configuration in the POM or similar.
*
* @author Benjamin Bentmann
*/
public interface BeanConfigurationRequest
{
/**
* Gets the bean to configure. Eventually, a valid request must have a bean set.
*
* @return The bean to configure, or {@code null} if none.
*/
Object getBean();
/**
* Sets the bean to configure. Eventually, a valid request must have a bean set.
*
* @param bean The bean to configure, may be {@code null}.
* @return This request for chaining, never {@code null}.
*/
BeanConfigurationRequest setBean( Object bean );
/**
* Gets the configuration to unmarshal into the bean.
*
* @return The configuration to unmarshal into the bean or {@code null} if none.
*/
Object getConfiguration();
/**
* Sets the configuration to unmarshal into the bean. The configuration should be taken from
* {@link org.apache.maven.model.ConfigurationContainer#getConfiguration()} or a similar source.
* Fully equivalent to {@code setConfiguration(configuration, null)}.
*
* @param configuration The configuration to unmarshal, may be {@code null}.
* @return This request for chaining, never {@code null}.
*/
BeanConfigurationRequest setConfiguration( Object configuration );
/**
* Sets the configuration to unmarshal into the bean. The configuration should be taken from
* {@link org.apache.maven.model.ConfigurationContainer#getConfiguration()} or a similar source.
* If {@code element} is not {@code null}, child configuration element with the specified name will
* be unmarshaled.
*
* @param configuration The configuration to unmarshal, may be {@code null}.
* @param element Configuration element name to unmarshal or {@code null} to unmarshal entire configuration.
* @return This request for chaining, never {@code null}.
*/
BeanConfigurationRequest setConfiguration( Object configuration, String element );
/**
* Returns configuration element name or {@code null}.
*
* @see #setConfiguration(Object, String)
*
* @return Configuration element name or {@code null}
*/
String getConfigurationElement();
/**
* Gets the class loader from which to load any types referenced by the configuration. If unset, the class loader of
* the bean class will be used.
*
* @return The class loader to load referenced types from or {@code null} if unset.
*/
ClassLoader getClassLoader();
/**
* Sets the class loader from which to load any types referenced by the configuration. If unset, the class loader of
* the bean class will be used.
*
* @param classLoader The class loader to load referenced types from, may be {@code null}.
* @return This request for chaining, never {@code null}.
*/
BeanConfigurationRequest setClassLoader( ClassLoader classLoader );
/**
* Gets the optional preprocessor for configuration values.
*
* @return The preprocessor for configuration values or {@code null} if none.
*/
BeanConfigurationValuePreprocessor getValuePreprocessor();
/**
* Sets the optional preprocessor for configuration values.
*
* @param valuePreprocessor The preprocessor for configuration values, may be {@code null} if unneeded.
* @return This request for chaining, never {@code null}.
*/
BeanConfigurationRequest setValuePreprocessor( BeanConfigurationValuePreprocessor valuePreprocessor );
/**
* Gets the optional path translator for configuration values unmarshalled to files.
*
* @return The path translator for files or {@code null} if none.
*/
BeanConfigurationPathTranslator getPathTranslator();
/**
* Sets the optional path translator for configuration values unmarshalled to files.
*
* @param pathTranslator The path translator for files, may be {@code null} if unneeded.
* @return This request for chaining, never {@code null}.
*/
BeanConfigurationRequest setPathTranslator( BeanConfigurationPathTranslator pathTranslator );
}
|
