DefaultBeanConfigurationRequest (Maven Core 3.1.1 API)

java.lang.Object
- org.apache.maven.configuration.DefaultBeanConfigurationRequest

All Implemented Interfaces:

BeanConfigurationRequest
```
public class DefaultBeanConfigurationRequest
extends Object
implements BeanConfigurationRequest
```
A basic bean configuration request.

Author:

Benjamin Bentmann

Constructor Summary

Constructors
Constructor and Description

DefaultBeanConfigurationRequest()

Constructors
Constructor and Description
`DefaultBeanConfigurationRequest()`

Method Summary

Methods
Modifier and Type	Method and Description
`Object`	`getBean()` Gets the bean to configure.
`ClassLoader`	`getClassLoader()` Gets the class loader from which to load any types referenced by the configuration.
`Object`	`getConfiguration()` Gets the configuration to unmarshal into the bean.
`String`	`getConfigurationElement()` Returns configuration element name or `null`.
`BeanConfigurationPathTranslator`	`getPathTranslator()` Gets the optional path translator for configuration values unmarshalled to files.
`BeanConfigurationValuePreprocessor`	`getValuePreprocessor()` Gets the optional preprocessor for configuration values.
`DefaultBeanConfigurationRequest`	`setBean(Object bean)` Sets the bean to configure.
`DefaultBeanConfigurationRequest`	`setClassLoader(ClassLoader classLoader)` Sets the class loader from which to load any types referenced by the configuration.
`DefaultBeanConfigurationRequest`	`setConfiguration(Model model, String pluginGroupId, String pluginArtifactId, String pluginExecutionId)` Sets the configuration to the configuration taken from the specified build plugin in the POM.
`DefaultBeanConfigurationRequest`	`setConfiguration(Object configuration)` Sets the configuration to unmarshal into the bean.
`DefaultBeanConfigurationRequest`	`setConfiguration(Object configuration, String element)` Sets the configuration to unmarshal into the bean.
`DefaultBeanConfigurationRequest`	`setPathTranslator(BeanConfigurationPathTranslator pathTranslator)` Sets the optional path translator for configuration values unmarshalled to files.
`DefaultBeanConfigurationRequest`	`setValuePreprocessor(BeanConfigurationValuePreprocessor valuePreprocessor)` Sets the optional preprocessor for configuration values.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DefaultBeanConfigurationRequest
```
public DefaultBeanConfigurationRequest()
```
- Method Detail
  - getBean
```
public Object getBean()
```
    Description copied from interface: BeanConfigurationRequest
    
    Gets the bean to configure. Eventually, a valid request must have a bean set.
    
    Specified by:
    
    getBean in interface BeanConfigurationRequest
    
    Returns:
    The bean to configure, or null if none.
  - setBean
```
public DefaultBeanConfigurationRequest setBean(Object bean)
```
    Description copied from interface: BeanConfigurationRequest
    
    Sets the bean to configure. Eventually, a valid request must have a bean set.
    
    Specified by:
    
    setBean in interface BeanConfigurationRequest
    
    Parameters:
    bean - The bean to configure, may be null.
    
    Returns:
    This request for chaining, never null.
  - getConfiguration
```
public Object getConfiguration()
```
    Description copied from interface: BeanConfigurationRequest
    
    Gets the configuration to unmarshal into the bean.
    
    Specified by:
    
    getConfiguration in interface BeanConfigurationRequest
    
    Returns:
    The configuration to unmarshal into the bean or null if none.
  - getConfigurationElement
```
public String getConfigurationElement()
```
    Description copied from interface: BeanConfigurationRequest
    
    Returns configuration element name or null.
    
    Specified by:
    
    getConfigurationElement in interface BeanConfigurationRequest
    
    Returns:
    Configuration element name or null
    See Also:
    BeanConfigurationRequest.setConfiguration(Object, String)
  - setConfiguration
```
public DefaultBeanConfigurationRequest setConfiguration(Object configuration)
```
    Description copied from interface: BeanConfigurationRequest
    
    Sets the configuration to unmarshal into the bean. The configuration should be taken from ConfigurationContainer.getConfiguration() or a similar source. Fully equivalent to setConfiguration(configuration, null).
    
    Specified by:
    
    setConfiguration in interface BeanConfigurationRequest
    
    Parameters:
    configuration - The configuration to unmarshal, may be null.
    
    Returns:
    This request for chaining, never null.
  - setConfiguration
```
public DefaultBeanConfigurationRequest setConfiguration(Object configuration,
                                               String element)
```
    Description copied from interface: BeanConfigurationRequest
    
    Sets the configuration to unmarshal into the bean. The configuration should be taken from ConfigurationContainer.getConfiguration() or a similar source. If element is not null, child configuration element with the specified name will be unmarshaled.
    
    Specified by:
    
    setConfiguration in interface BeanConfigurationRequest
    
    Parameters:
    configuration - The configuration to unmarshal, may be null.
    element - Configuration element name to unmarshal or null to unmarshal entire configuration.
    
    Returns:
    This request for chaining, never null.
  - setConfiguration
```
public DefaultBeanConfigurationRequest setConfiguration(Model model,
                                               String pluginGroupId,
                                               String pluginArtifactId,
                                               String pluginExecutionId)
```
    Sets the configuration to the configuration taken from the specified build plugin in the POM. First, the build plugins will be searched for the specified plugin, if that fails, the plugin management section will be searched.
    
    Parameters:
    model - The POM to extract the plugin configuration from, may be null.
    pluginGroupId - The group id of the plugin whose configuration should be used, must not be null or empty.
    pluginArtifactId - The artifact id of the plugin whose configuration should be used, must not be null or empty.
    pluginExecutionId - The id of a plugin execution whose configuration should be used, may be null or empty to use the general plugin configuration.
    
    Returns:
    This request for chaining, never null.
  - getClassLoader
```
public ClassLoader getClassLoader()
```
    Description copied from interface: BeanConfigurationRequest
    
    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.
    
    Specified by:
    
    getClassLoader in interface BeanConfigurationRequest
    
    Returns:
    The class loader to load referenced types from or null if unset.
  - setClassLoader
```
public DefaultBeanConfigurationRequest setClassLoader(ClassLoader classLoader)
```
    Description copied from interface: BeanConfigurationRequest
    
    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.
    
    Specified by:
    
    setClassLoader in interface BeanConfigurationRequest
    
    Parameters:
    classLoader - The class loader to load referenced types from, may be null.
    
    Returns:
    This request for chaining, never null.
  - getValuePreprocessor
```
public BeanConfigurationValuePreprocessor getValuePreprocessor()
```
    Description copied from interface: BeanConfigurationRequest
    
    Gets the optional preprocessor for configuration values.
    
    Specified by:
    
    getValuePreprocessor in interface BeanConfigurationRequest
    
    Returns:
    The preprocessor for configuration values or null if none.
  - setValuePreprocessor
```
public DefaultBeanConfigurationRequest setValuePreprocessor(BeanConfigurationValuePreprocessor valuePreprocessor)
```
    Description copied from interface: BeanConfigurationRequest
    
    Sets the optional preprocessor for configuration values.
    
    Specified by:
    
    setValuePreprocessor in interface BeanConfigurationRequest
    
    Parameters:
    valuePreprocessor - The preprocessor for configuration values, may be null if unneeded.
    
    Returns:
    This request for chaining, never null.
  - getPathTranslator
```
public BeanConfigurationPathTranslator getPathTranslator()
```
    Description copied from interface: BeanConfigurationRequest
    
    Gets the optional path translator for configuration values unmarshalled to files.
    
    Specified by:
    
    getPathTranslator in interface BeanConfigurationRequest
    
    Returns:
    The path translator for files or null if none.
  - setPathTranslator
```
public DefaultBeanConfigurationRequest setPathTranslator(BeanConfigurationPathTranslator pathTranslator)
```
    Description copied from interface: BeanConfigurationRequest
    
    Sets the optional path translator for configuration values unmarshalled to files.
    
    Specified by:
    
    setPathTranslator in interface BeanConfigurationRequest
    
    Parameters:
    pathTranslator - The path translator for files, may be null if unneeded.
    
    Returns:
    This request for chaining, never null.

Class DefaultBeanConfigurationRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultBeanConfigurationRequest

Method Detail

getBean

setBean

getConfiguration

getConfigurationElement

setConfiguration

setConfiguration

setConfiguration

getClassLoader

setClassLoader

getValuePreprocessor

setValuePreprocessor

getPathTranslator

setPathTranslator