/* @VaadinApache2LicenseForJavaFiles@ */ package com.vaadin.data.util; import java.io.IOException; import java.lang.reflect.InvocationTargetException; import java.lang.reflect.Method; import java.util.logging.Level; import java.util.logging.Logger; import com.vaadin.data.Property; import com.vaadin.util.SerializerHelper; /** *
* 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.
*
* MethodProperty implements Property.ValueChangeNotifier, but does not * automatically know whether or not the getter method will actually return a * new value - value change listeners are always notified when setValue is * called, without verifying what the getter returns. *
* * @author Vaadin Ltd. * @version * @VERSION@ * @since 3.0 */ @SuppressWarnings("serial") public class MethodProperty
* 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 constructed from the bean property by adding * get/is/are/set prefix and capitalising the first character in the name of * the given bean property. *
* * @param instance * the object that includes the property. * @param beanPropertyName * the name of the property to bind to. */ @SuppressWarnings("unchecked") public MethodProperty(Object instance, String beanPropertyName) { final Class> beanClass = instance.getClass(); // Assure that the first letter is upper cased (it is a common // mistake to write firstName, not FirstName). if (Character.isLowerCase(beanPropertyName.charAt(0))) { final char[] buf = beanPropertyName.toCharArray(); buf[0] = Character.toUpperCase(buf[0]); beanPropertyName = new String(buf); } // Find the get method getMethod = null; try { getMethod = initGetterMethod(beanPropertyName, beanClass); } catch (final java.lang.NoSuchMethodException ignored) { throw new MethodException(this, "Bean property " + beanPropertyName + " can not be found"); } // In case the get method is found, resolve the type Class> returnType = getMethod.getReturnType(); // Finds the set method setMethod = null; try { setMethod = beanClass.getMethod("set" + beanPropertyName, new Class[] { returnType }); } catch (final java.lang.NoSuchMethodException skipped) { } // Gets the return type from get method if (returnType.isPrimitive()) { type = (Class
* 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.
*
* 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.
*
* 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 the getArgs as arguments. The setArgs will be used as the
* arguments for the setter method, though the argument indexed by the
* setArgumentIndex will be replaced with the argument passed to the
* {@link #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}
*
setArgs
to be
* replaced with newValue
when
* {@link #setValue(Object newValue)} is called.
*/
@SuppressWarnings("unchecked")
public MethodProperty(Class extends T> type, Object instance,
String getMethodName, String setMethodName, Object[] getArgs,
Object[] setArgs, int setArgumentIndex) {
// Check the setargs and setargs index
if (setMethodName != null && setArgs == null) {
throw new IndexOutOfBoundsException("The setArgs can not be null");
}
if (setMethodName != null
&& (setArgumentIndex < 0 || setArgumentIndex >= setArgs.length)) {
throw new IndexOutOfBoundsException(
"The setArgumentIndex must be >= 0 and < setArgs.length");
}
// Set type
this.type = type;
// Find set and get -methods
final Method[] m = instance.getClass().getMethods();
// Finds get method
boolean found = false;
for (int i = 0; i < m.length; i++) {
// Tests the name of the get Method
if (!m[i].getName().equals(getMethodName)) {
// name does not match, try next method
continue;
}
// Tests return type
if (!type.equals(m[i].getReturnType())) {
continue;
}
// Tests the parameter types
final Class>[] c = m[i].getParameterTypes();
if (c.length != getArgs.length) {
// not the right amount of parameters, try next method
continue;
}
int j = 0;
while (j < c.length) {
if (getArgs[j] != null
&& !c[j].isAssignableFrom(getArgs[j].getClass())) {
// parameter type does not match, try next method
break;
}
j++;
}
if (j == c.length) {
// all paramteters matched
if (found == true) {
throw new MethodException(this,
"Could not uniquely identify " + getMethodName
+ "-method");
} else {
found = true;
getMethod = m[i];
}
}
}
if (found != true) {
throw new MethodException(this, "Could not find " + getMethodName
+ "-method");
}
// Finds set method
if (setMethodName != null) {
// Finds setMethod
found = false;
for (int i = 0; i < m.length; i++) {
// Checks name
if (!m[i].getName().equals(setMethodName)) {
// name does not match, try next method
continue;
}
// Checks parameter compatibility
final Class>[] c = m[i].getParameterTypes();
if (c.length != setArgs.length) {
// not the right amount of parameters, try next method
continue;
}
int j = 0;
while (j < c.length) {
if (setArgs[j] != null
&& !c[j].isAssignableFrom(setArgs[j].getClass())) {
// parameter type does not match, try next method
break;
} else if (j == setArgumentIndex && !c[j].equals(type)) {
// Property type is not the same as setArg type
break;
}
j++;
}
if (j == c.length) {
// all parameters match
if (found == true) {
throw new MethodException(this,
"Could not identify unique " + setMethodName
+ "-method");
} else {
found = true;
setMethod = m[i];
}
}
}
if (found != true) {
throw new MethodException(this, "Could not identify "
+ setMethodName + "-method");
}
}
// Gets the return type from get method
this.type = (Class
* Creates a new instance of MethodProperty
from the getter and
* setter methods, and argument lists.
*
* This constructor behaves exactly like * {@link #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. *
* * @param type * the type of the property. * @param instance * the object that includes the property. * @param getMethod * the getter method. * @param setMethod * the setter method. * @param getArgs * the fixed argument list to be passed to the getter method. * @param setArgs * the fixed argument list to be passed to the setter method. * @param setArgumentIndex * the index of the argument insetArgs
to be
* replaced with newValue
when
* {@link #setValue(Object newValue)} is called.
*/
@SuppressWarnings("unchecked")
// cannot use "Class extends T>" because of automatic primitive type
// conversions
public MethodProperty(Class> type, Object instance, Method getMethod,
Method setMethod, Object[] getArgs, Object[] setArgs,
int setArgumentIndex) {
if (getMethod == null) {
throw new MethodException(this,
"Property GET-method cannot not be null: " + type);
}
if (setMethod != null) {
if (setArgs == null) {
throw new IndexOutOfBoundsException(
"The setArgs can not be null");
}
if (setArgumentIndex < 0 || setArgumentIndex >= setArgs.length) {
throw new IndexOutOfBoundsException(
"The setArgumentIndex must be >= 0 and < setArgs.length");
}
}
// Gets the return type from get method
Class extends T> convertedType = (Class extends T>) convertPrimitiveType(type);
this.getMethod = getMethod;
this.setMethod = setMethod;
setArguments(getArgs, setArgs, setArgumentIndex);
this.instance = instance;
this.type = convertedType;
}
/**
* Find a getter method for a property (getXyz(), isXyz() or areXyz()).
*
* @param propertyName
* name of the property
* @param beanClass
* class in which to look for the getter methods
* @return Method
* @throws NoSuchMethodException
* if no getter found
*/
static Method initGetterMethod(String propertyName, final Class> beanClass)
throws NoSuchMethodException {
propertyName = propertyName.substring(0, 1).toUpperCase()
+ propertyName.substring(1);
Method getMethod = null;
try {
getMethod = beanClass.getMethod("get" + propertyName,
new Class[] {});
} catch (final java.lang.NoSuchMethodException ignored) {
try {
getMethod = beanClass.getMethod("is" + propertyName,
new Class[] {});
} catch (final java.lang.NoSuchMethodException ignoredAsWell) {
getMethod = beanClass.getMethod("are" + propertyName,
new Class[] {});
}
}
return getMethod;
}
static Class> convertPrimitiveType(Class> type) {
// Gets the return type from get method
if (type.isPrimitive()) {
if (type.equals(Boolean.TYPE)) {
type = Boolean.class;
} else if (type.equals(Integer.TYPE)) {
type = Integer.class;
} else if (type.equals(Float.TYPE)) {
type = Float.class;
} else if (type.equals(Double.TYPE)) {
type = Double.class;
} else if (type.equals(Byte.TYPE)) {
type = Byte.class;
} else if (type.equals(Character.TYPE)) {
type = Character.class;
} else if (type.equals(Short.TYPE)) {
type = Short.class;
} else if (type.equals(Long.TYPE)) {
type = Long.class;
}
}
return type;
}
/**
* 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
.
*
* @return type of the Property
*/
public final Class extends T> getType() {
return type;
}
/**
* Tests if the object is in read-only mode. In read-only mode calls to
* setValue
will throw ReadOnlyException
and will
* not modify the value of the Property.
*
* @return true
if the object is in read-only mode,
* false
if it's not
*/
@Override
public boolean isReadOnly() {
return super.isReadOnly() || (setMethod == null);
}
/**
* Gets the value stored in the Property. The value is resolved by calling
* the specified getter method with the argument specified at instantiation.
*
* @return the value of the Property
*/
public T getValue() {
try {
return (T) getMethod.invoke(instance, getArgs);
} catch (final Throwable e) {
throw new MethodException(this, e);
}
}
/**
* * Sets the setter method and getter method argument lists. *
* * @param getArgs * the fixed argument list to be passed to the getter method. * @param setArgs * the fixed argument list to be passed to the setter method. * @param setArgumentIndex * the index of the argument insetArgs
to be
* replaced with newValue
when
* {@link #setValue(Object newValue)} is called.
*/
public void setArguments(Object[] getArgs, Object[] setArgs,
int setArgumentIndex) {
this.getArgs = new Object[getArgs.length];
for (int i = 0; i < getArgs.length; i++) {
this.getArgs[i] = getArgs[i];
}
this.setArgs = new Object[setArgs.length];
for (int i = 0; i < setArgs.length; i++) {
this.setArgs[i] = setArgs[i];
}
this.setArgumentIndex = setArgumentIndex;
}
/**
* Sets the value of the property.
*
* Note that since Vaadin 7, no conversions are performed and the value must
* be of the correct type.
*
* @param newValue
* the New value of the property.
* @throws Property.ReadOnlyException
if the object is in
* read-only mode.
* @see #invokeSetMethod(Object)
*/
@SuppressWarnings("unchecked")
public void setValue(Object newValue) throws Property.ReadOnlyException {
// Checks the mode
if (isReadOnly()) {
throw new Property.ReadOnlyException();
}
// Checks the type of the value
if (newValue != null && !type.isAssignableFrom(newValue.getClass())) {
throw new IllegalArgumentException(
"Invalid value type for ObjectProperty.");
}
invokeSetMethod((T) newValue);
fireValueChange();
}
/**
* Internal method to actually call the setter method of the wrapped
* property.
*
* @param value
*/
protected void invokeSetMethod(T value) {
try {
// Construct a temporary argument array only if needed
if (setArgs.length == 1) {
setMethod.invoke(instance, new Object[] { value });
} else {
// Sets the value to argument array
final Object[] args = new Object[setArgs.length];
for (int i = 0; i < setArgs.length; i++) {
args[i] = (i == setArgumentIndex) ? value : setArgs[i];
}
setMethod.invoke(instance, args);
}
} catch (final InvocationTargetException e) {
final Throwable targetException = e.getTargetException();
throw new MethodException(this, targetException);
} catch (final Exception e) {
throw new MethodException(this, e);
}
}
/**
* Exception
object that signals that there were problems
* calling or finding the specified getter or setter methods of the
* property.
*
* @author Vaadin Ltd.
* @version
* @VERSION@
* @since 3.0
*/
@SuppressWarnings("rawtypes")
// Exceptions cannot be parameterized, ever.
public static class MethodException extends RuntimeException {
/**
* The method property from which the exception originates from
*/
private final Property property;
/**
* Cause of the method exception
*/
private Throwable cause;
/**
* Constructs a new MethodException
with the specified
* detail message.
*
* @param property
* the property.
* @param msg
* the detail message.
*/
public MethodException(Property property, String msg) {
super(msg);
this.property = property;
}
/**
* Constructs a new MethodException
from another exception.
*
* @param property
* the property.
* @param cause
* the cause of the exception.
*/
public MethodException(Property property, Throwable cause) {
this.property = property;
this.cause = cause;
}
/**
* @see java.lang.Throwable#getCause()
*/
@Override
public Throwable getCause() {
return cause;
}
/**
* Gets the method property this exception originates from.
*
* @return MethodProperty or null if not a valid MethodProperty
*/
public MethodProperty getMethodProperty() {
return (property instanceof MethodProperty) ? (MethodProperty) property
: null;
}
/**
* Gets the method property this exception originates from.
*
* @return Property from which the exception originates
*/
public Property getProperty() {
return property;
}
}
/**
* Sends a value change event to all registered listeners.
*
* Public for backwards compatibility, visibility may be reduced in future
* versions.
*/
@Override
public void fireValueChange() {
super.fireValueChange();
}
private static final Logger getLogger() {
return Logger.getLogger(MethodProperty.class.getName());
}
}
677' href='#n677'>677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184