| java.lang.Object
 org.millstone.base.data.util.MethodProperty
| MethodProperty | | public class MethodProperty implements Property(Code) | | Proxy class for creating Properties from pairs of getter and setter
methods of a Bean property. An instance of this class can be thought as
having been attached to a field of an object. Accessing the object
through the Property interface directly manipulates the underlying
field.
It's assumed that the return value returned by the getter method
is assignable to the type of the property, and the setter method
parameter is assignable to that value.
A valid getter method must always be available, but instance of this
class can be constructed with a null setter method in which
case the resulting MethodProperty is read-only.
author:
IT Mill Ltd.
version:
3.1.1
since:
3.0 |
| Constructor Summary | |
| public | MethodProperty(Object instance, String beanPropertyName)
Creates a new instance of MethodProperty from a named bean
property. | | public | MethodProperty(Class type, Object instance, String getMethodName, String setMethodName)
Creates a new instance of MethodProperty from named getter and
setter methods. | | public | MethodProperty(Class type, Object instance, Method getMethod, Method setMethod)
Creates a new instance of MethodProperty with the getter and
setter methods. | | public | MethodProperty(Class type, Object instance, String getMethodName, String setMethodName, Object[] getArgs, Object[] setArgs, int setArgumentIndex)
Creates a new instance of MethodProperty from named getter and
setter methods and argument lists. | | public | MethodProperty(Class type, Object instance, Method getMethod, Method setMethod, Object[] getArgs, Object[] setArgs, int setArgumentIndex)
Creates a new instance of MethodProperty from the getter and
setter methods, and argument lists. |
| MethodProperty | | public MethodProperty(Object instance, String beanPropertyName)(Code) | | Creates a new instance of MethodProperty from a named bean
property. This constructor takes an object and the name of a bean
property and initializes itself with the accessor methods for the
property. The getter method of a MethodProperty instantiated
with this constructor will be called with no arguments, and the
setter method with only the new value as the sole argument.
If the setter method is unavailable, the resulting MethodProperty
will be read-only, otherwise it will be read-write.
Method names are constucted from the bean property by adding
get/is/are/set prefix and capitalising the first character in the
name of the given bean property
Parameters:
instance - object that includes the property
Parameters:
beanPropertyName - name of the property to bind to |
| MethodProperty | | public MethodProperty(Class type, Object instance, String getMethodName, String setMethodName)(Code) | | Creates a new instance of MethodProperty from named getter and
setter methods. The getter method of a MethodProperty instantiated
with this constructor will be called with no arguments, and the
setter method with only the new value as the sole argument.
If the setter method is null, the resulting
MethodProperty will be read-only, otherwise it will be
read-write.
Parameters:
type - type of the property
Parameters:
instance - object that includes the property
Parameters:
getMethodName - name of the getter method
Parameters:
setMethodName - name of the setter method |
| MethodProperty | | public MethodProperty(Class type, Object instance, Method getMethod, Method setMethod)(Code) | | Creates a new instance of MethodProperty with the getter and
setter methods. The getter method of a MethodProperty instantiated
with this constructor will be called with no arguments, and the
setter method with only the new value as the sole argument.
If the setter method is null, the resulting
MethodProperty will be read-only, otherwise it will be
read-write.
Parameters:
type - type of the property
Parameters:
instance - object that includes the property
Parameters:
getMethod - the getter method
Parameters:
setMethod - the setter method |
| MethodProperty | | public MethodProperty(Class type, Object instance, String getMethodName, String setMethodName, Object[] getArgs, Object[] setArgs, int setArgumentIndex)(Code) | | Creates a new instance of MethodProperty from named getter and
setter methods and argument lists. The getter method of a
MethodProperty instantiated with this constructor will be called with
getArgs as arguments. setArgs will be used
as the arguments for the setter method, though the argument indexed
by setArgumentIndex will be replaced with the argument
passed to the
MethodProperty.setValue(Object newValue) method.
For example, if the setArgs contains A,
B and C, and setArgumentIndex =
1, the call methodProperty.setValue(X) would
result in the setter method to be called with the parameter set of
{A, X, C}
Parameters:
type - type of the property
Parameters:
instance - object that includes the property
Parameters:
getMethodName - the name of the getter method
Parameters:
setMethodName - the name of the setter method
Parameters:
getArgs - fixed argument list to be passed to the getter method
Parameters:
setArgs - fixed argument list to be passed to the setter method
Parameters:
setArgumentIndex - the index of the argument insetArgs to be replaced with newValue whenMethodProperty.setValue(Object newValue) is called |
| MethodProperty | | public MethodProperty(Class type, Object instance, Method getMethod, Method setMethod, Object[] getArgs, Object[] setArgs, int setArgumentIndex)(Code) | | Creates a new instance of MethodProperty from the getter and
setter methods, and argument lists. This constructor behaves exctly
like
MethodProperty.MethodProperty(Class type,Object instance,String getMethodName,String setMethodName,Object[] getArgs,Object[] setArgs,int setArgumentIndex) except that instead of names of
the getter and setter methods this constructor is given the actual
methods themselves.
Parameters:
type - type of the property
Parameters:
instance - object that includes the property
Parameters:
getMethod - the getter method
Parameters:
setMethod - the setter method
Parameters:
getArgs - fixed argument list to be passed to the getter method
Parameters:
setArgs - fixed argument list to be passed to the setter method
Parameters:
setArgumentIndex - the index of the argument insetArgs to be replaced with newValue whenMethodProperty.setValue(Object newValue) is called |
| getType | | final public Class getType()(Code) | | Returns the type of the Property. The methods getValue
and setValue must be compatible with this type: one
must be able to safely cast the value returned from
getValue to the given type and pass any variable
assignable to this type as an argument to setValue.
type of the Property |
| getValue | | public Object getValue()(Code) | | Gets the value stored in the Property. The value is resolved by
calling the specified getter method with the argument specified
at instantiation.
the value of the Property |
| isReadOnly | | public boolean isReadOnly()(Code) | | Tests if the object is in read-only mode. In read-only mode calls
to setValue will throw ReadOnlyExceptions
and will not modify the value of the Property.
true if the object is in read-only mode,false if it's not |
| setArguments | | public void setArguments(Object[] getArgs, Object[] setArgs, int setArgumentIndex)(Code) | | Sets the setter method and getter method argument lists.
Parameters:
getArgs - fixed argument list to be passed to the getter method
Parameters:
setArgs - fixed argument list to be passed to the setter method
Parameters:
setArgumentIndex - the index of the argument insetArgs to be replaced with newValue whenMethodProperty.setValue(Object newValue) is called |
| setReadOnly | | public void setReadOnly(boolean newStatus)(Code) | | Sets the Property's read-only mode to the specified status.
Parameters:
newStatus - new read-only status of the Property |
| setValue | | public void setValue(Object newValue) throws Property.ReadOnlyException, Property.ConversionException(Code) | | Set the value of the property. This method supports setting from
Strings if either String is directly
assignable to property type, or the type class contains a string
constructor.
Parameters:
newValue - New value of the property. Property.ReadOnlyException if the object is inread-only mode Property.ConversionException ifnewValue can't be converted into the Property's nativetype directly or through String |
| toString | | public String toString()(Code) | | Returns the value of the MethodProperty in human readable textual
format. The return value should be assignable to the
setValue method if the Property is not in read-only
mode.
String representation of the value stored in the Property |
|
|