Package org.apache.maven.configuration

Interface BeanConfigurationRequest

  • All Known Implementing Classes:
    DefaultBeanConfigurationRequest
    public interface BeanConfigurationRequest
    A request to configure a bean from some configuration in the POM or similar.
    Author:
    Benjamin Bentmann

    • Method Detail

      • getBean

        Object getBean()
        Gets the bean to configure. Eventually, a valid request must have a bean set.
        Returns:
        The bean to configure, or null if none.

      • setBean

        BeanConfigurationRequest setBean​(Object bean)
        Sets the bean to configure. Eventually, a valid request must have a bean set.
        Parameters:
        bean - The bean to configure, may be null.
        Returns:
        This request for chaining, never null.

      • getConfiguration

        Object getConfiguration()
        Gets the configuration to unmarshal into the bean.
        Returns:
        The configuration to unmarshal into the bean or null if none.

      • setConfiguration

        BeanConfigurationRequest setConfiguration​(Object configuration)
        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).
        Parameters:
        configuration - The configuration to unmarshal, may be null.
        Returns:
        This request for chaining, never null.

      • setConfiguration

        BeanConfigurationRequest setConfiguration​(Object configuration,
                                          String element)
        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.
        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.

      • getConfigurationElement

        String getConfigurationElement()
        Returns configuration element name or null.
        Returns:
        Configuration element name or null
        See Also:
        setConfiguration(Object, String)

      • getClassLoader

        ClassLoader getClassLoader()
        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.
        Returns:
        The class loader to load referenced types from or null if unset.

      • setClassLoader

        BeanConfigurationRequest setClassLoader​(ClassLoader classLoader)
        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.
        Parameters:
        classLoader - The class loader to load referenced types from, may be null.
        Returns:
        This request for chaining, never null.

      • getValuePreprocessor

        BeanConfigurationValuePreprocessor getValuePreprocessor()
        Gets the optional preprocessor for configuration values.
        Returns:
        The preprocessor for configuration values or null if none.

      • setValuePreprocessor

        BeanConfigurationRequest setValuePreprocessor​(BeanConfigurationValuePreprocessor valuePreprocessor)
        Sets the optional preprocessor for configuration values.
        Parameters:
        valuePreprocessor - The preprocessor for configuration values, may be null if unneeded.
        Returns:
        This request for chaining, never null.

      • getPathTranslator

        BeanConfigurationPathTranslator getPathTranslator()
        Gets the optional path translator for configuration values unmarshalled to files.
        Returns:
        The path translator for files or null if none.

      • setPathTranslator

        BeanConfigurationRequest setPathTranslator​(BeanConfigurationPathTranslator pathTranslator)
        Sets the optional path translator for configuration values unmarshalled to files.
        Parameters:
        pathTranslator - The path translator for files, may be null if unneeded.
        Returns:
        This request for chaining, never null.