1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
/* * @(#)BeanContextChild.java 1.21 05/11/17 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package java.beans.beancontext; import java.beans.PropertyChangeListener; import java.beans.VetoableChangeListener; import java.beans.PropertyVetoException; import java.beans.beancontext.BeanContext; /** * <p> * JavaBeans wishing to be nested within, and obtain a reference to their * execution environment, or context, as defined by the BeanContext * sub-interface shall implement this interface. * </p> * <p> * Conformant BeanContexts shall as a side effect of adding a BeanContextChild * object shall pass a reference to itself via the setBeanContext() method of * this interface. * </p> * <p> * Note that a BeanContextChild may refuse a change in state by throwing * PropertyVetoedException in response. * </p> * <p> * In order for persistence mechanisms to function properly on BeanContextChild * instances across a broad variety of scenarios, implementing classes of this * interface are required to define as transient, any or all fields, or * instance variables, that may contain, or represent, references to the * nesting BeanContext instance or other resources obtained * from the BeanContext via any unspecified mechanisms. * </p> * * @author Laurence P. G. Cable * @version 1.21, 11/17/05 * @since 1.2 * * @see java.beans.beancontext.BeanContext * @see java.beans.PropertyChangeEvent * @see java.beans.PropertyChangeListener * @see java.beans.PropertyVetoEvent * @see java.beans.PropertyVetoListener * @see java.beans.PropertyVetoException */ public interface BeanContextChild { /** * <p> * Objects that implement this interface, * shall fire a java.beans.PropertyChangeEvent, with parameters: * * propertyName "beanContext", oldValue (the previous nesting * <code>BeanContext</code> instance, or <code>null</code>), * newValue (the current nesting * <code>BeanContext</code> instance, or <code>null</code>). * <p> * A change in the value of the nesting BeanContext property of this * BeanContextChild may be vetoed by throwing the appropriate exception. * </p> * @param bc The <code>BeanContext</code> with which * to associate this <code>BeanContextChild</code>. * @throws <code>PropertyVetoException</code> if the * addition of the specified <code>BeanContext</code> is refused. */ void setBeanContext(BeanContext bc) throws PropertyVetoException; /** * Gets the <code>BeanContext</code> associated * with this <code>BeanContextChild</code>. * @return the <code>BeanContext</code> associated * with this <code>BeanContextChild</code>. */ BeanContext getBeanContext(); /** * Adds a <code>PropertyChangeListener</code> * to this <code>BeanContextChild</code> * in order to receive a <code>PropertyChangeEvent</code> * whenever the specified property has changed. * @param name the name of the property to listen on * @param pcl the <code>PropertyChangeListener</code> to add */ void addPropertyChangeListener(String name, PropertyChangeListener pcl); /** * Removes a <code>PropertyChangeListener</code> from this * <code>BeanContextChild</code> so that it no longer * receives <code>PropertyChangeEvents</code> when the * specified property is changed. * * @param name the name of the property that was listened on * @param pcl the <code>PropertyChangeListener</code> to remove */ void removePropertyChangeListener(String name, PropertyChangeListener pcl); /** * Adds a <code>VetoableChangeListener</code> to * this <code>BeanContextChild</code> * to receive events whenever the specified property changes. * @param name the name of the property to listen on * @param vcl the <code>VetoableChangeListener</code> to add */ void addVetoableChangeListener(String name, VetoableChangeListener vcl); /** * Removes a <code>VetoableChangeListener</code> from this * <code>BeanContextChild</code> so that it no longer receives * events when the specified property changes. * @param name the name of the property that was listened on. * @param vcl the <code>VetoableChangeListener</code> to remove. */ void removeVetoableChangeListener(String name, VetoableChangeListener vcl); }