001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *  http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019
020package org.apache.xbean.osgi.bundle.util;
021
022import org.osgi.framework.Bundle;
023import org.osgi.framework.BundleReference;
024
025/**
026 * DelegatingBundleReference is based on {@link BundleReference} and provides
027 * access to {@link DelegatingBundle}.  
028 */
029public interface DelegatingBundleReference extends BundleReference {
030
031    /**
032     * Returns the bundle associated with this classloader.
033     * 
034     * In most cases the bundle associated with the classloader is a regular framework bundle. 
035     * However, in some cases the bundle associated with the classloader is a {@link DelegatingBundle}.
036     * In such cases, the <tt>unwrap</tt> parameter controls whether this function returns the
037     * {@link DelegatingBundle} instance or the main application bundle backing with the {@link DelegatingBundle}.
038     *
039     * @param unwrap If true and if the bundle associated with this classloader is a {@link DelegatingBundle}, 
040     *        this function will return the main application bundle backing with the {@link DelegatingBundle}. 
041     *        Otherwise, the bundle associated with this classloader is returned as is.
042     * @return The bundle associated with this classloader.
043     */
044    public Bundle getBundle(boolean unwrap);
045
046}