diff options
Diffstat (limited to 'framework/src/maven/apache-maven-3.3.3/maven-core/src/main/java/org/apache/maven/configuration/BeanConfigurationRequest.java')
-rw-r--r-- | framework/src/maven/apache-maven-3.3.3/maven-core/src/main/java/org/apache/maven/configuration/BeanConfigurationRequest.java | 130 |
1 files changed, 130 insertions, 0 deletions
diff --git a/framework/src/maven/apache-maven-3.3.3/maven-core/src/main/java/org/apache/maven/configuration/BeanConfigurationRequest.java b/framework/src/maven/apache-maven-3.3.3/maven-core/src/main/java/org/apache/maven/configuration/BeanConfigurationRequest.java new file mode 100644 index 00000000..d19aa204 --- /dev/null +++ b/framework/src/maven/apache-maven-3.3.3/maven-core/src/main/java/org/apache/maven/configuration/BeanConfigurationRequest.java @@ -0,0 +1,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 ); + +} |