/* DefaultPersistenceDelegate.java
|
/* DefaultPersistenceDelegate.java
|
Copyright (C) 2005 Free Software Foundation, Inc.
|
Copyright (C) 2005 Free Software Foundation, Inc.
|
|
|
This file is part of GNU Classpath.
|
This file is part of GNU Classpath.
|
|
|
GNU Classpath is free software; you can redistribute it and/or modify
|
GNU Classpath is free software; you can redistribute it and/or modify
|
it under the terms of the GNU General Public License as published by
|
it under the terms of the GNU General Public License as published by
|
the Free Software Foundation; either version 2, or (at your option)
|
the Free Software Foundation; either version 2, or (at your option)
|
any later version.
|
any later version.
|
|
|
GNU Classpath is distributed in the hope that it will be useful, but
|
GNU Classpath is distributed in the hope that it will be useful, but
|
WITHOUT ANY WARRANTY; without even the implied warranty of
|
WITHOUT ANY WARRANTY; without even the implied warranty of
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
General Public License for more details.
|
General Public License for more details.
|
|
|
You should have received a copy of the GNU General Public License
|
You should have received a copy of the GNU General Public License
|
along with GNU Classpath; see the file COPYING. If not, write to the
|
along with GNU Classpath; see the file COPYING. If not, write to the
|
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
|
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
|
02110-1301 USA.
|
02110-1301 USA.
|
|
|
Linking this library statically or dynamically with other modules is
|
Linking this library statically or dynamically with other modules is
|
making a combined work based on this library. Thus, the terms and
|
making a combined work based on this library. Thus, the terms and
|
conditions of the GNU General Public License cover the whole
|
conditions of the GNU General Public License cover the whole
|
combination.
|
combination.
|
|
|
As a special exception, the copyright holders of this library give you
|
As a special exception, the copyright holders of this library give you
|
permission to link this library with independent modules to produce an
|
permission to link this library with independent modules to produce an
|
executable, regardless of the license terms of these independent
|
executable, regardless of the license terms of these independent
|
modules, and to copy and distribute the resulting executable under
|
modules, and to copy and distribute the resulting executable under
|
terms of your choice, provided that you also meet, for each linked
|
terms of your choice, provided that you also meet, for each linked
|
independent module, the terms and conditions of the license of that
|
independent module, the terms and conditions of the license of that
|
module. An independent module is a module which is not derived from
|
module. An independent module is a module which is not derived from
|
or based on this library. If you modify this library, you may extend
|
or based on this library. If you modify this library, you may extend
|
this exception to your version of the library, but you are not
|
this exception to your version of the library, but you are not
|
obligated to do so. If you do not wish to do so, delete this
|
obligated to do so. If you do not wish to do so, delete this
|
exception statement from your version. */
|
exception statement from your version. */
|
|
|
|
|
package java.beans;
|
package java.beans;
|
|
|
import java.lang.reflect.InvocationTargetException;
|
import java.lang.reflect.InvocationTargetException;
|
import java.lang.reflect.Method;
|
import java.lang.reflect.Method;
|
|
|
/** <p><code>DefaultPersistenceDelegate</code> is a {@link PersistenceDelegate}
|
/** <p><code>DefaultPersistenceDelegate</code> is a {@link PersistenceDelegate}
|
* implementation that can be used to serialize objects which adhere to the
|
* implementation that can be used to serialize objects which adhere to the
|
* Java Beans naming convention.</p>
|
* Java Beans naming convention.</p>
|
*
|
*
|
* @author Robert Schuster (robertschuster@fsfe.org)
|
* @author Robert Schuster (robertschuster@fsfe.org)
|
* @since 1.4
|
* @since 1.4
|
*/
|
*/
|
public class DefaultPersistenceDelegate extends PersistenceDelegate
|
public class DefaultPersistenceDelegate extends PersistenceDelegate
|
{
|
{
|
|
|
private String[] constructorPropertyNames;
|
private String[] constructorPropertyNames;
|
|
|
/** Using this constructor the object to be serialized will be instantiated
|
/** Using this constructor the object to be serialized will be instantiated
|
* with the default non-argument constructor.
|
* with the default non-argument constructor.
|
*/
|
*/
|
public DefaultPersistenceDelegate()
|
public DefaultPersistenceDelegate()
|
{
|
{
|
}
|
}
|
|
|
/** This constructor allows to specify which Bean properties appear
|
/** This constructor allows to specify which Bean properties appear
|
* in the constructor.
|
* in the constructor.
|
*
|
*
|
* <p>The implementation reads the mentioned properties from the Bean
|
* <p>The implementation reads the mentioned properties from the Bean
|
* instance and applies it in the given order to a corresponding
|
* instance and applies it in the given order to a corresponding
|
* constructor.</p>
|
* constructor.</p>
|
*
|
*
|
* @param constructorPropertyNames The properties the Bean's constructor
|
* @param constructorPropertyNames The properties the Bean's constructor
|
* should be given to.
|
* should be given to.
|
*/
|
*/
|
public DefaultPersistenceDelegate(String[] constructorPropertyNames)
|
public DefaultPersistenceDelegate(String[] constructorPropertyNames)
|
{
|
{
|
this.constructorPropertyNames = constructorPropertyNames;
|
this.constructorPropertyNames = constructorPropertyNames;
|
}
|
}
|
|
|
protected boolean mutatesTo(Object oldInstance, Object newInstance)
|
protected boolean mutatesTo(Object oldInstance, Object newInstance)
|
{
|
{
|
try
|
try
|
{
|
{
|
|
|
return (constructorPropertyNames != null
|
return (constructorPropertyNames != null
|
&& constructorPropertyNames.length > 0
|
&& constructorPropertyNames.length > 0
|
&& oldInstance.getClass()
|
&& oldInstance.getClass()
|
.getDeclaredMethod("equals",
|
.getDeclaredMethod("equals",
|
new Class[] { Object.class }) != null)
|
new Class[] { Object.class }) != null)
|
? oldInstance.equals(newInstance)
|
? oldInstance.equals(newInstance)
|
: super.mutatesTo(oldInstance, newInstance);
|
: super.mutatesTo(oldInstance, newInstance);
|
}
|
}
|
catch (NoSuchMethodException nsme)
|
catch (NoSuchMethodException nsme)
|
{
|
{
|
return super.mutatesTo(oldInstance, newInstance);
|
return super.mutatesTo(oldInstance, newInstance);
|
}
|
}
|
}
|
}
|
|
|
protected Expression instantiate(Object oldInstance, Encoder out)
|
protected Expression instantiate(Object oldInstance, Encoder out)
|
{
|
{
|
Object[] args = null;
|
Object[] args = null;
|
|
|
try
|
try
|
{
|
{
|
// If there are property names in the array, then we create
|
// If there are property names in the array, then we create
|
// a corresponding argument array and store every
|
// a corresponding argument array and store every
|
// argument in it. To retrieve an argument object we have
|
// argument in it. To retrieve an argument object we have
|
// dig up the right property in the bean class' BeanInfo
|
// dig up the right property in the bean class' BeanInfo
|
// object.
|
// object.
|
// This is so costly in terms of execution time I better
|
// This is so costly in terms of execution time I better
|
// not think twice about it ...
|
// not think twice about it ...
|
if (constructorPropertyNames != null)
|
if (constructorPropertyNames != null)
|
{
|
{
|
args = new Object[constructorPropertyNames.length];
|
args = new Object[constructorPropertyNames.length];
|
|
|
// Look up the properties of oldInstance's class to find matches for
|
// Look up the properties of oldInstance's class to find matches for
|
// the
|
// the
|
// names given in the constructor.
|
// names given in the constructor.
|
PropertyDescriptor[] propertyDescs = Introspector.getBeanInfo(
|
PropertyDescriptor[] propertyDescs = Introspector.getBeanInfo(
|
oldInstance.getClass()).getPropertyDescriptors();
|
oldInstance.getClass()).getPropertyDescriptors();
|
|
|
for (int i = 0; i < constructorPropertyNames.length; i++)
|
for (int i = 0; i < constructorPropertyNames.length; i++)
|
{
|
{
|
// Scan the property descriptions for a matching name.
|
// Scan the property descriptions for a matching name.
|
for (int j = 0; j < propertyDescs.length; j++)
|
for (int j = 0; j < propertyDescs.length; j++)
|
{
|
{
|
if (propertyDescs[i].getName().equals(
|
if (propertyDescs[i].getName().equals(
|
constructorPropertyNames[i]))
|
constructorPropertyNames[i]))
|
{
|
{
|
Method readMethod = propertyDescs[i].getReadMethod();
|
Method readMethod = propertyDescs[i].getReadMethod();
|
|
|
args[i] = readMethod.invoke(oldInstance);
|
args[i] = readMethod.invoke(oldInstance);
|
}
|
}
|
}
|
}
|
}
|
}
|
}
|
}
|
|
|
}
|
}
|
catch (IllegalAccessException iae)
|
catch (IllegalAccessException iae)
|
{
|
{
|
out.getExceptionListener().exceptionThrown(iae);
|
out.getExceptionListener().exceptionThrown(iae);
|
}
|
}
|
catch (IllegalArgumentException iarge)
|
catch (IllegalArgumentException iarge)
|
{
|
{
|
out.getExceptionListener().exceptionThrown(iarge);
|
out.getExceptionListener().exceptionThrown(iarge);
|
}
|
}
|
catch (InvocationTargetException ite)
|
catch (InvocationTargetException ite)
|
{
|
{
|
out.getExceptionListener().exceptionThrown(ite);
|
out.getExceptionListener().exceptionThrown(ite);
|
}
|
}
|
catch (IntrospectionException ie)
|
catch (IntrospectionException ie)
|
{
|
{
|
out.getExceptionListener().exceptionThrown(ie);
|
out.getExceptionListener().exceptionThrown(ie);
|
}
|
}
|
|
|
return new Expression(oldInstance, oldInstance.getClass(), "new", args);
|
return new Expression(oldInstance, oldInstance.getClass(), "new", args);
|
}
|
}
|
|
|
protected void initialize(Class<?> type, Object oldInstance,
|
protected void initialize(Class<?> type, Object oldInstance,
|
Object newInstance, Encoder out)
|
Object newInstance, Encoder out)
|
{
|
{
|
// Calling the supertype's implementation of initialize makes it
|
// Calling the supertype's implementation of initialize makes it
|
// possible that descendants of classes like AbstractHashMap
|
// possible that descendants of classes like AbstractHashMap
|
// or Hashtable are serialized correctly. This mechanism grounds on
|
// or Hashtable are serialized correctly. This mechanism grounds on
|
// two other facts:
|
// two other facts:
|
// * Each class which has not registered a special purpose
|
// * Each class which has not registered a special purpose
|
// PersistenceDelegate is handled by a DefaultPersistenceDelegate
|
// PersistenceDelegate is handled by a DefaultPersistenceDelegate
|
// instance.
|
// instance.
|
// * PersistenceDelegate.initialize() is implemented in a way that it
|
// * PersistenceDelegate.initialize() is implemented in a way that it
|
// calls the initialize method of the superclass' persistence delegate.
|
// calls the initialize method of the superclass' persistence delegate.
|
super.initialize(type, oldInstance, newInstance, out);
|
super.initialize(type, oldInstance, newInstance, out);
|
|
|
// Suppresses the writing of property setting statements when this delegate
|
// Suppresses the writing of property setting statements when this delegate
|
// is not used for the exact instance type. By doing so the following code
|
// is not used for the exact instance type. By doing so the following code
|
// is called only once per object.
|
// is called only once per object.
|
if (type != oldInstance.getClass())
|
if (type != oldInstance.getClass())
|
return;
|
return;
|
|
|
try
|
try
|
{
|
{
|
PropertyDescriptor[] propertyDescs = Introspector.getBeanInfo(
|
PropertyDescriptor[] propertyDescs = Introspector.getBeanInfo(
|
oldInstance.getClass()).getPropertyDescriptors();
|
oldInstance.getClass()).getPropertyDescriptors();
|
|
|
for (int i = 0; i < propertyDescs.length; i++)
|
for (int i = 0; i < propertyDescs.length; i++)
|
{
|
{
|
Method readMethod = propertyDescs[i].getReadMethod();
|
Method readMethod = propertyDescs[i].getReadMethod();
|
Method writeMethod = propertyDescs[i].getWriteMethod();
|
Method writeMethod = propertyDescs[i].getWriteMethod();
|
|
|
if (readMethod != null && writeMethod != null)
|
if (readMethod != null && writeMethod != null)
|
{
|
{
|
Object oldValue = readMethod.invoke(oldInstance);
|
Object oldValue = readMethod.invoke(oldInstance);
|
|
|
if (oldValue != null)
|
if (oldValue != null)
|
out.writeStatement(new Statement(oldInstance,
|
out.writeStatement(new Statement(oldInstance,
|
writeMethod.getName(),
|
writeMethod.getName(),
|
new Object[] { oldValue }));
|
new Object[] { oldValue }));
|
}
|
}
|
}
|
}
|
}
|
}
|
catch (IntrospectionException ie)
|
catch (IntrospectionException ie)
|
{
|
{
|
out.getExceptionListener().exceptionThrown(ie);
|
out.getExceptionListener().exceptionThrown(ie);
|
}
|
}
|
catch (IllegalAccessException iae)
|
catch (IllegalAccessException iae)
|
{
|
{
|
out.getExceptionListener().exceptionThrown(iae);
|
out.getExceptionListener().exceptionThrown(iae);
|
}
|
}
|
catch (InvocationTargetException ite)
|
catch (InvocationTargetException ite)
|
{
|
{
|
out.getExceptionListener().exceptionThrown(ite);
|
out.getExceptionListener().exceptionThrown(ite);
|
}
|
}
|
}
|
}
|
}
|
}
|
|
|
