Generated by
JDiff

java.beans Documentation Differences

This file contains all the changes in documentation in the package java.beans as colored differences. Deletions are shown like this, and additions are shown like this.
If no deletions or additions are shown in an entry, the HTML tags will be what has changed. The new HTML tags are shown in the differences. If no documentation existed, and then some was added in a later version, this change is noted in the appropriate class pages of differences, but the change is not shown on this page. Only changes in existing text are shown here. Similarly, documentation which was inherited from another class or interface is not shown here.
Note that an HTML error in the new documentation may cause the display of other documentation changes to be presented incorrectly. For instance, failure to close a <code> tag will cause all subsequent paragraphs to be displayed differently.

Class AppletInitializer

This interface is designed to work in collusion with java.beans.Beans.instantiate. The interafce is intended to provide mechanism to allow the proper initialization of JavaBeans that are also Applets during their instantiation by java.beans.Beans.instantiate().

@see java.beans.Beans#instantiate @version 1.8 0210 12/0203/0001 @since 1.2
Class AppletInitializer, void activate(Applet)

Activate and/or mark Applet active. Implementors of this interface shall mark this Applet as active and optionally invoke its start() method.

@param newApplet The newly instantiated JavaBean
Class AppletInitializer, void initialize(Applet, BeanContext)

If passed to the appropriate variant of java.beans.Beans.instantiate this method will be called in order to associate the newly instantiated Applet (JavaBean) with its AppletContext AppletStub and Container.

Conformant implementations shall:

  1. Associate the newly instantiated Applet with the appropriate AppletContext.
  2. Instantiate an AppletStub() and associate that AppletStub with the Applet via an invocation of setStub().
  3. If BeanContext parameter is null then it shall associate the Applet with its appropriate Container by adding that Applet to its Container via an invocation of add(). If the BeanContext parameter is non-null then it is the responsibility of the BeanContext to associate the Applet with its Container during the subsequent invocation of its addChildren() method.

@param newAppletBean The newly instantiated JavaBean @param bCtxt The BeanContext intended for this Applet or null.

Class DesignMode

This interface is intended to be implemented by or delegated from instances of java.beans.beancontext.BeanContext in order to propagate to its nested hierarchy of java.beans.beancontext.BeanContextChild instances the current "designTime" property.

The JavaBeans specification defines the notion of design time as is a mode in which JavaBeans instances should function during their composition and customization in a interactive design composition or construction tool as opposed to runtime when the JavaBean is part of an applet application or other live Java executable abstraction. @author Laurence P. G. Cable @version 1.11 0212 12/0203/0001 @since 1.2 @see java.beans.beancontext.BeanContext @see java.beans.beancontext.BeanContextChild @see java.beans.beancontext.BeanContextMembershipListener @see java.beans.PropertyChangeEvent


Class EventSetDescriptor, constructor EventSetDescriptor(Class, String, Class, String)

ThisCreates constructor creates an EventSetDescriptor assuming that you are following the most simple standard design pattern where a named event ""fred"" is (1) delivered as a call on the single method of interface FredListener (2) has a single argument of type FredEvent and (3) where the FredListener may be registered with a call on an addFredListener method of the source component and removed with a call on a removeFredListener method. @param sourceClass The class firing the event. @param eventSetName The programmatic name of the event. E.g. ""fred"". Note that this should normally start with a lower-case character. @param listenerType The target interface that events will get delivered to. @param listenerMethodName The method that will get called when the event gets delivered to its target listener interface. @exception IntrospectionException if an exception occurs during introspection.
Class EventSetDescriptor, constructor EventSetDescriptor(Class, String, Class, String[], String, String)

ThisCreates constructor creates an EventSetDescriptor from scratch using string names. @param sourceClass The class firing the event. @param eventSetName The programmatic name of the event set. Note that this should normally start with a lower-case character. @param listenerType The Class of the target interface that events will get delivered to. @param listenerMethodNames The names of the methods that will get called when the event gets delivered to its target listener interface. @param addListenerMethodName The name of the method on the event source that can be used to register an event listener object. @param removeListenerMethodName The name of the method on the event source that can be used to de-register an event listener object. @exception IntrospectionException if an exception occurs during introspection.
Class EventSetDescriptor, constructor EventSetDescriptor(String, Class, MethodDescriptor[], Method, Method)

ThisCreates constructor creates an EventSetDescriptor from scratch using java.lang.reflect.MethodDescriptor and java.lang.Class objects. @param eventSetName The programmatic name of the event set. @param listenerType The Class for the listener interface. @param listenerMethodDescriptors An array of MethodDescriptor objects describing each of the event handling methods in the target listener. @param addListenerMethod The method on the event source that can be used to register an event listener object. @param removeListenerMethod The method on the event source that can be used to de-register an event listener object. @exception IntrospectionException if an exception occurs during introspection.
Class EventSetDescriptor, constructor EventSetDescriptor(String, Class, Method[], Method, Method)

ThisCreates constructor creates an EventSetDescriptor from scratch using java.lang.reflect.Method and java.lang.Class objects. @param eventSetName The programmatic name of the event set. @param listenerType The Class for the listener interface. @param listenerMethods An array of Method objects describing each of the event handling methods in the target listener. @param addListenerMethod The method on the event source that can be used to register an event listener object. @param removeListenerMethod The method on the event source that can be used to de-register an event listener object. @exception IntrospectionException if an exception occurs during introspection.
Class EventSetDescriptor, MethodDescriptor[] getListenerMethodDescriptors()

Gets the MethodDescriptors of the target listener interface. @return An array of MethodDescriptor objects for the target methods within the target listener interface that will get called when events are fired.
Class EventSetDescriptor, Method[] getListenerMethods()

Gets the methods of the target listener interface. @return An array of Method objects for the target methods within the target listener interface that will get called when events are fired.
Class EventSetDescriptor, Class getListenerType()

Gets the Class object for the target interface. @return The Class object for the target interface that will get invoked when the event is fired.
Class EventSetDescriptor, boolean isInDefaultEventSet()

ReportReports if an event set is in the ""default" set". @return Truetrue if the event set is in the ""default" set". Defaults to "true".
Class EventSetDescriptor, boolean isUnicast()

Normally event sources are multicast. However there are some exceptions that are strictly unicast. @return Truetrue if the event set is unicast. Defaults to "false".
Class EventSetDescriptor, void setInDefaultEventSet(boolean)

MarkMarks an event set as being in the ""default"" set (or not). By default this is true. @param unicastinDefaultEventSet Truetrue if the event set is unicast.in the "default" set false if not

Class IndexedPropertyDescriptor, boolean equals(Object)

IndicatesCompares whether some other object is "equal to" this one. The equals method implements an equivalence relation: It is reflexive: for any reference value x x.equals(x) should return true. It is symmetric: for any reference values x and y x.equals(y) should return truePropertyDescriptor if andagainst only ifthe specified yobject.equals(x) returnsReturns true. It is transitive: for any reference values x y and z if x.equals(y) returns true and y.equals(z) returns true then x.equals(z) should return true. It is consistent: for any reference values x and y multiple invocations of x.equals(y) consistently return true or consistently return false provided no information used in equals comparisons on the object is modified. For any non-null reference value x x.equals(null) should return false. The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is for any reference values x and y this method returns true if and onlyare if x and y refer to the same object (x==y has the. valueTwo truePropertyDescriptor).s @param objare the reference object with which to compare. @return truesame if this object is the same as the objread write property types argument;property falseeditor otherwise.and @seeflags java.langare equivalent.Boolean#hashCode() @seesince java.util1.Hashtable4

Class Introspector

The Introspector class provides a standard way for tools to learn about the properties events and methods supported by a target Java Bean.

For each of those three kinds of information the Introspector will separately analyze the bean's class and superclasses looking for either explicit or implicit information and use that information to build a BeanInfo object that comprehensively describes the target bean.

For each class "Foo" explicit information may be available if there exists a corresponding "FooBeanInfo" class that provides a non-null value when queried for the information. We first look for the BeanInfo class by taking the full package-qualified name of the target bean class and appending "BeanInfo" to form a new class name. If this fails then we take the final classname component of this name and look for that class in each of the packages specified in the BeanInfo package search path.

Thus for a class such as "sun.xyz.OurButton" we would first look for a BeanInfo class called "sun.xyz.OurButtonBeanInfo" and if that failed we'd look in each package in the BeanInfo search path for an OurButtonBeanInfo class. With the default search path this would mean looking for "sun.beans.infos.OurButtonBeanInfo".

If a class provides explicit BeanInfo about itself then we add that to the BeanInfo information we obtained from analyzing any derived classes but we regard the explicit information as being definitive for the current class and its base classes and do not proceed any further up the superclass chain.

If we don't find explicit BeanInfo on a class we use low-level reflection to study the methods of the class and apply standard design patterns to identify property accessors event sources or public methods. We then proceed to analyze the class's superclass and add in the information from it (and possibly on up the superclass chain).

For more information about introspection and design patterns please consult the JavaBeans specification.

Class Introspector, void flushFromCaches(Class)

Flush the Introspector's internal cached information for a given class. This method is not normally required. It is normally only needed by advanced tools that update existing "Class" objects in-place and need to make the Introspector re-analyze an existing Class object. Note that only the direct state associated with the target Class object is flushed. We do not flush state for other Class objects with the same name nor do we flush state for any related Class objects (such as subclasses) even though their state may include information indirectly obtained from the target Class object. @param clz Class object to be flushed. @throws NullPointerException If the Class object is null.
Class Introspector, BeanInfo getBeanInfo(Class)

Introspect on a Java beanBean and learn about all its properties exposed methods and events.

If the BeanInfo class for a Java Bean has been previously Introspected then the BeanInfo class is retrieved from the BeanInfo cache. @param beanClass The bean class to be analyzed. @return A BeanInfo object describing the target bean. @exception IntrospectionException if an exception occurs during introspection. @see #flushCaches @see #flushFromCaches

Class Introspector, BeanInfo getBeanInfo(Class, Class)

Introspect on a Java bean and learn all about its properties exposed methods below a given "stop" point.

If the BeanInfo class for a Java Bean has been previously Introspected based on the same arguments then the BeanInfo class is retrieved from the BeanInfo cache. @param bean The bean class to be analyzed. @param stopClass The baseclass at which to stop the analysis. Any methods/properties/events in the stopClass or in its baseclasses will be ignored in the analysis. @exception IntrospectionException if an exception occurs during introspection.

Class Introspector, BeanInfo getBeanInfo(Class, int)

Introspect on a Java bean and learn about all its properties exposed methods and events subject to some control flags.

If the BeanInfo class for a Java Bean has been previously Introspected based on the same arguments then the BeanInfo class is retrieved from the BeanInfo cache. @param beanClass The bean class to be analyzed. @param flags Flags to control the introspection. If flags == USE_ALL_BEANINFO then we use all of the BeanInfo classes we can discover. If flags == IGNORE_IMMEDIATE_BEANINFO then we ignore any BeanInfo associated with the specified beanClass. If flags == IGNORE_ALL_BEANINFO then we ignore all BeanInfo associated with the specified beanClass or any of its parent classes. @return A BeanInfo object describing the target bean. @exception IntrospectionException if an exception occurs during introspection.

Class Introspector, void setBeanInfoSearchPath(String[])

Change the list of package names that will be used for finding BeanInfo classes. The behaviour of this method is undefined if parameter path is null.

First if there is a security manager its checkPropertiesAccess method is called. This could result in a SecurityException. @param path Array of package names. @exception SecurityException if a security manager exists and its checkPropertiesAccess method doesn't allow setting of system properties. @see SecurityManager#checkPropertiesAccess


Class PropertyDescriptor, boolean equals(Object)

IndicatesCompares whether some other object is "equal to" this one. The equals method implements an equivalence relation: It is reflexive: for any reference value x x.equals(x) should return true. It is symmetric: for any reference values x and y x.equals(y) should return truePropertyDescriptor if andagainst only ifthe specified yobject.equals(x) returnsReturns true. It is transitive: for any reference values x y and z if x.equals(y) returns true and y.equals(z) returns true then x.equals(z) should return true. It is consistent: for any reference values x and y multiple invocations of x.equals(y) consistently return true or consistently return false provided no information used in equals comparisons on the object is modified. For any non-null reference value x x.equals(null) should return false. The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is for any reference values x and y this method returns true if and onlyare if x and y refer to the same object (x==y has the. valueTwo truePropertyDescriptor).s @param objare the reference object with which to compare. @return truesame if this object is the same as the objread write property types argument;property falseeditor otherwise.and @seeflags java.langare equivalent.Boolean#hashCode() @seesince java.util1.Hashtable4

Class VetoableChangeSupport, void removeVetoableChangeListener(VetoableChangeListener)

Remove a VetoableChangeListener from the listener list. This removes a PropertyChangeListenerVetoableChangeListener that was registered for all properties. @param listener The VetoableChangeListener to be removed