/* * Copyright (c) 1997, 2006, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as * published by the Free Software Foundation. Oracle designates this * particular file as subject to the "Classpath" exception as provided * by Oracle in the LICENSE file that accompanied this code. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License * version 2 for more details (a copy is included in the LICENSE file that * accompanied this code). * * You should have received a copy of the GNU General Public License version * 2 along with this work; if not, write to the Free Software Foundation, * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. * * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA * or visit www.oracle.com if you need additional information or have any * questions. */ package java.beans.beancontext; import java.beans.DesignMode; import java.beans.Visibility; import java.io.InputStream; import java.io.IOException; import java.net.URL; import java.util.Collection; import java.util.Locale; /** *
* The BeanContext acts a logical hierarchical container for JavaBeans. *
* * @author Laurence P. G. Cable * @since 1.2 * * @see java.beans.Beans * @see java.beans.beancontext.BeanContextChild * @see java.beans.beancontext.BeanContextMembershipListener * @see java.beans.PropertyChangeEvent * @see java.beans.DesignMode * @see java.beans.Visibility * @see java.util.Collection */ public interface BeanContext extends BeanContextChild, Collection, DesignMode, Visibility { /** * Instantiate the javaBean named as a * child of thisBeanContext
.
* The implementation of the JavaBean is
* derived from the value of the beanName parameter,
* and is defined by the
* java.beans.Beans.instantiate()
method.
*
* @param beanName The name of the JavaBean to instantiate
* as a child of this BeanContext
* @throws IOException
* @throws ClassNotFoundException
if the class identified
* by the beanName parameter is not found
*/
Object instantiateChild(String beanName) throws IOException, ClassNotFoundException;
/**
* Analagous to java.lang.ClassLoader.getResourceAsStream()
,
* this method allows a BeanContext
implementation
* to interpose behavior between the child Component
* and underlying ClassLoader
.
*
* @param name the resource name
* @param bcc the specified child
* @return an InputStream
for reading the resource,
* or null
if the resource could not
* be found.
* @throws IllegalArgumentException
if
* the resource is not valid
*/
InputStream getResourceAsStream(String name, BeanContextChild bcc) throws IllegalArgumentException;
/**
* Analagous to java.lang.ClassLoader.getResource()
, this
* method allows a BeanContext
implementation to interpose
* behavior between the child Component
* and underlying ClassLoader
.
*
* @param name the resource name
* @param bcc the specified child
* @return a URL
for the named
* resource for the specified child
* @throws IllegalArgumentException
* if the resource is not valid
*/
URL getResource(String name, BeanContextChild bcc) throws IllegalArgumentException;
/**
* Adds the specified BeanContextMembershipListener
* to receive BeanContextMembershipEvents
from
* this BeanContext
whenever it adds
* or removes a child Component
(s).
*
* @param bcml the BeanContextMembershipListener
to be added
*/
void addBeanContextMembershipListener(BeanContextMembershipListener bcml);
/**
* Removes the specified BeanContextMembershipListener
* so that it no longer receives BeanContextMembershipEvent
s
* when the child Component
(s) are added or removed.
*
* @param bcml the BeanContextMembershipListener
* to be removed
*/
void removeBeanContextMembershipListener(BeanContextMembershipListener bcml);
/**
* This global lock is used by both BeanContext
* and BeanContextServices
implementors
* to serialize changes in a BeanContext
* hierarchy and any service requests etc.
*/
public static final Object globalHierarchyLock = new Object();
}