001package org.apache.commons.beanutils2;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *   http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022/**
023 * Allows to specify a {@link ClassLoader} for loading a class by name.
024 */
025public interface ClassLoaderBuilder
026{
027
028    /**
029     * Use the class loader of the currently executing thread for loading the class. In other words use the class loader
030     * returned by {@code Thread.currentThread().getContextClassLoader()}.
031     *
032     * @return a {@link ClassAccessor} wrapping the loaded class.
033     * @throws BeanClassNotFoundException no class with the given could be found.
034     */
035    ClassAccessor<?> loadWithThreadContextClassLoader();
036
037    /**
038     * Use the class loader that loaded {@code org.apache.commons.beanutils2.BeanUtils2} to load the class.
039     *
040     * @return a {@link ClassAccessor} wrapping the loaded class.
041     * @throws BeanClassNotFoundException no class with the given could be found.
042     */
043    ClassAccessor<?> loadWithBeanUtilsClassLoader();
044
045    /**
046     * Use a custom {@link ClassLoader} for loading the class.
047     *
048     * @param classLoader the {@link ClassLoader} to load the class. Must not be {@code null}!
049     * @return a {@link ClassAccessor} wrapping the loaded class.
050     * @throws BeanClassNotFoundException no class with the given could be found.
051     */
052    ClassAccessor<?> loadWith( ClassLoader classLoader );
053
054}