/* java.beans.Expression
|
/* java.beans.Expression
|
Copyright (C) 2004, 2005 Free Software Foundation, Inc.
|
Copyright (C) 2004, 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;
|
|
|
/**
|
/**
|
* <p>An Expression captures the execution of an object method
|
* <p>An Expression captures the execution of an object method
|
* that returns a value.</p>
|
* that returns a value.</p>
|
*
|
*
|
* <p>It stores an object, the method to call, and the arguments to pass to
|
* <p>It stores an object, the method to call, and the arguments to pass to
|
* the method.</p>
|
* the method.</p>
|
*
|
*
|
* <p>While this class can generally be used to describe method calls it is
|
* <p>While this class can generally be used to describe method calls it is
|
* part of the XML serialization API.</p>
|
* part of the XML serialization API.</p>
|
*
|
*
|
* @author Robert Schuster (robertschuster@fsfe.org)
|
* @author Robert Schuster (robertschuster@fsfe.org)
|
* @since 1.4
|
* @since 1.4
|
*/
|
*/
|
public class Expression extends Statement
|
public class Expression extends Statement
|
{
|
{
|
// This is a placeholder to indicate that value hasn't been set
|
// This is a placeholder to indicate that value hasn't been set
|
// yet;
|
// yet;
|
private static final Object UNSET = new Object();
|
private static final Object UNSET = new Object();
|
|
|
// The value to return. This is equal to unset until getValue is called.
|
// The value to return. This is equal to unset until getValue is called.
|
private Object value;
|
private Object value;
|
|
|
/**
|
/**
|
* Constructor Constructs an Expression representing the invocation of
|
* Constructor Constructs an Expression representing the invocation of
|
* object.methodName(arg[0], arg[1], ...); However, it will never be executed.
|
* object.methodName(arg[0], arg[1], ...); However, it will never be executed.
|
* Instead, value will always be returned.
|
* Instead, value will always be returned.
|
*
|
*
|
* @param value
|
* @param value
|
* The value to return.
|
* The value to return.
|
* @param target
|
* @param target
|
* The object to invoke the method on.
|
* The object to invoke the method on.
|
* @param methodName
|
* @param methodName
|
* The object method to invoke.
|
* The object method to invoke.
|
* @param arguments
|
* @param arguments
|
* An array of arguments to pass to the method.
|
* An array of arguments to pass to the method.
|
*/
|
*/
|
public Expression(Object value, Object target, String methodName,
|
public Expression(Object value, Object target, String methodName,
|
Object[] arguments)
|
Object[] arguments)
|
{
|
{
|
super(target, methodName, arguments);
|
super(target, methodName, arguments);
|
this.value = value;
|
this.value = value;
|
}
|
}
|
|
|
/**
|
/**
|
* Constructor Constructs an Expression representing the invocation of
|
* Constructor Constructs an Expression representing the invocation of
|
* object.methodName(arg[0], arg[1], ...);
|
* object.methodName(arg[0], arg[1], ...);
|
*
|
*
|
* @param target
|
* @param target
|
* The object to invoke the method on.
|
* The object to invoke the method on.
|
* @param methodName
|
* @param methodName
|
* The object method to invoke.
|
* The object method to invoke.
|
* @param arguments
|
* @param arguments
|
* An array of arguments to pass to the method.
|
* An array of arguments to pass to the method.
|
*/
|
*/
|
public Expression(Object target, String methodName, Object[] arguments)
|
public Expression(Object target, String methodName, Object[] arguments)
|
{
|
{
|
super(target, methodName, arguments);
|
super(target, methodName, arguments);
|
this.value = UNSET;
|
this.value = UNSET;
|
}
|
}
|
|
|
/**
|
/**
|
* Return the result of executing the method. If the cached value has not yet
|
* Return the result of executing the method. If the cached value has not yet
|
* been set, the method is executed in the same way as Statement.execute(),
|
* been set, the method is executed in the same way as Statement.execute(),
|
* except that the value is cached, and then returned. If the value has been
|
* except that the value is cached, and then returned. If the value has been
|
* set, it is returned without executing the method again.
|
* set, it is returned without executing the method again.
|
*
|
*
|
* @return the result of executing the method.
|
* @return the result of executing the method.
|
* @exception Exception
|
* @exception Exception
|
* if an error occurs
|
* if an error occurs
|
*/
|
*/
|
public Object getValue() throws Exception
|
public Object getValue() throws Exception
|
{
|
{
|
if (value == UNSET)
|
if (value == UNSET)
|
value = doExecute();
|
value = doExecute();
|
return value;
|
return value;
|
}
|
}
|
|
|
/**
|
/**
|
* Set the cached value to be returned by getValue()
|
* Set the cached value to be returned by getValue()
|
*
|
*
|
* @param value
|
* @param value
|
* the value to cache and return.
|
* the value to cache and return.
|
*/
|
*/
|
public void setValue(Object value)
|
public void setValue(Object value)
|
{
|
{
|
this.value = value;
|
this.value = value;
|
}
|
}
|
|
|
/**
|
/**
|
* Return a string representation of this expression.
|
* Return a string representation of this expression.
|
*/
|
*/
|
public String toString()
|
public String toString()
|
{
|
{
|
String result = super.toString();
|
String result = super.toString();
|
if (value != UNSET)
|
if (value != UNSET)
|
return value.getClass().getName() + "=" + result;
|
return value.getClass().getName() + "=" + result;
|
return result;
|
return result;
|
}
|
}
|
}
|
}
|
|
|
