View Javadoc
1   package org.apache.commons.beanutils2;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  /**
23   * Allows to specify a {@link ClassLoader} for loading a class by name.
24   */
25  public interface ClassLoaderBuilder
26  {
27  
28      /**
29       * Use the class loader of the currently executing thread for loading the class. In other words use the class loader
30       * returned by {@code Thread.currentThread().getContextClassLoader()}.
31       *
32       * @return a {@link ClassAccessor} wrapping the loaded class.
33       * @throws BeanClassNotFoundException no class with the given could be found.
34       */
35      ClassAccessor<?> loadWithThreadContextClassLoader();
36  
37      /**
38       * Use the class loader that loaded {@code org.apache.commons.beanutils2.BeanUtils2} to load the class.
39       *
40       * @return a {@link ClassAccessor} wrapping the loaded class.
41       * @throws BeanClassNotFoundException no class with the given could be found.
42       */
43      ClassAccessor<?> loadWithBeanUtilsClassLoader();
44  
45      /**
46       * Use a custom {@link ClassLoader} for loading the class.
47       *
48       * @param classLoader the {@link ClassLoader} to load the class. Must not be {@code null}!
49       * @return a {@link ClassAccessor} wrapping the loaded class.
50       * @throws BeanClassNotFoundException no class with the given could be found.
51       */
52      ClassAccessor<?> loadWith( ClassLoader classLoader );
53  
54  }