Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  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(s):
Benjamin Bentmann
 
 public interface BeanConfigurationRequest
 {

    
Gets the bean to configure. Eventually, a valid request must have a bean set.

Returns:
The bean to configure, or null if none.
 
     Object getBean();

    
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.
 
     BeanConfigurationRequest setBeanObject bean );

    
Gets the configuration to unmarshal into the bean.

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

    
Sets the configuration to unmarshal into the bean. The configuration should be taken from org.apache.maven.model.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.
 
     BeanConfigurationRequest setConfigurationObject configuration );

    
Sets the configuration to unmarshal into the bean. The configuration should be taken from org.apache.maven.model.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.
 
     BeanConfigurationRequest setConfigurationObject configurationString element );

    
Returns configuration element name or null.

Returns:
Configuration element name or null
See also:
setConfiguration(java.lang.Object,java.lang.String)
 
     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.

Returns:
The class loader to load referenced types from or 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.

Parameters:
classLoader The class loader to load referenced types from, may be null.
Returns:
This request for chaining, never null.
 
     BeanConfigurationRequest setClassLoaderClassLoader classLoader );

    
Gets the optional preprocessor for configuration values.

Returns:
The preprocessor for configuration values or null if none.
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.
Gets the optional path translator for configuration values unmarshalled to files.

Returns:
The path translator for files or null if none.
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.
New to GrepCode? Check out our FAQ X