propertyutil.java

Speedframework--基于类型元数据的羽量级ORM.完全基于Java类型元数据和反射机制同时不需要任何对象关系映射配置文件的轻量级ORM框架,它充分利用了类型本身的信息,使用Metadata

  }

  /**
   * Return the Java Class repesenting the property editor class that has
   * been registered for this property (if any).  This method follows the
   * same name resolution rules used by <code>getPropertyDescriptor()</code>,
   * so if the last element of a name reference is indexed, the property
   * editor for the underlying property's class is returned.
   * <p>
   * Note that <code>null</code> will be returned if there is no property,
   * or if there is no registered property editor class.  Because this
   * return value is ambiguous, you should determine the existence of the
   * property itself by other means.
   *
   * @param bean Bean for which a property descriptor is requested
   * @param name Possibly indexed and/or nested name of the property for
   *  which a property descriptor is requested
   *
   * @exception IllegalAccessException if the caller does not have
   *  access to the property accessor method
   * @exception IllegalArgumentException if a nested reference to a
   *  property returns null
   * @exception InvocationTargetException if the property accessor method
   *  throws an exception
   * @exception NoSuchMethodException if an accessor method for this
   *  propety cannot be found
   */
  public static Class getPropertyEditorClass(Object bean, String name) throws
      IllegalAccessException, InvocationTargetException,
      NoSuchMethodException {

    PropertyDescriptor descriptor =
        getPropertyDescriptor(bean, name);
    if (descriptor != null) {
      return (descriptor.getPropertyEditorClass());
    }
    else {
      return (null);
    }

  }

  /**
   * Return the Java Class repesenting the property type of the specified
   * property, or <code>null</code> if there is no such property for the
   * specified bean.  This method follows the same name resolution rules
   * used by <code>getPropertyDescriptor()</code>, so if the last element
   * of a name reference is indexed, the type of the property itself will
   * be returned.  If the last (or only) element has no property with the
   * specified name, <code>null</code> is returned.
   *
   * @param bean Bean for which a property descriptor is requested
   * @param name Possibly indexed and/or nested name of the property for
   *  which a property descriptor is requested
   *
   * @exception IllegalAccessExceptionif the caller does not have
   *  access to the property accessor method
   * @exception IllegalArgumentException if a nested reference to a
   *  property returns null
   * @exception InvocationTargetException if the property accessor method
   *  throws an exception
   * @exception NoSuchMethodException if an accessor method for this
   *  propety cannot be found
   */
  public static Class getPropertyType(Object bean, String name) throws
      IllegalAccessException, InvocationTargetException,
      NoSuchMethodException {

    PropertyDescriptor descriptor =
        getPropertyDescriptor(bean, name);
    if (descriptor != null) {
      return (descriptor.getPropertyType());
    }
    else {
      return (null);
    }

  }

  /**
   * Return the value of the specified simple property of the specified
   * bean, with no type conversions.
   *
   * @param bean Bean whose property is to be extracted
   * @param name Name of the property to be extracted
   *
   * @exception IllegalAccessException if the caller does not have
   *  access to the property accessor method
   * @exception InvocationTargetException if the property accessor method
   *  throws an exception
   * @exception NoSuchMethodException if an accessor method for this
   *  propety cannot be found
   */
  public static Object getSimpleProperty(Object bean, String name) throws
      IllegalAccessException, InvocationTargetException,
      NoSuchMethodException {

    // Retrieve the property getter method for the specified property
    PropertyDescriptor descriptor =
        getPropertyDescriptor(bean, name);
    if (descriptor == null) {
      throw new NoSuchMethodException("Unknown property '" +
                                      name + "'");
    }
    Method readMethod = descriptor.getReadMethod();
    if (readMethod == null) {
      throw new NoSuchMethodException("Property '" + name +
                                      "' has no getter method");
    }

    // Call the property getter and return the value
    Object value = readMethod.invoke(bean, new Object[0]);
    return (value);

  }

  /**
   * Set the value of the (possibly nested) property of the specified
   * name, for the specified bean, with no type conversions.
   *
   * @param bean Bean whose property is to be modified
   * @param name Possibly nested name of the property to be modified
   * @param value Value to which the property is to be set
   *
   * @exception IllegalAccessException if the caller does not have
   *  access to the property accessor method
   * @exception IllegalArgumentException if a nested reference to a
   *  property returns null
   * @exception InvocationTargetException if the property accessor method
   *  throws an exception
   * @exception NoSuchMethodException if an accessor method for this
   *  propety cannot be found
   */
  public static void setNestedProperty(Object bean,
                                       String name, Object value) throws
      IllegalAccessException, InvocationTargetException,
      NoSuchMethodException {

    while (true) {
      int period = name.indexOf(".");
      if (period < 0) {
        break;
      }
      String next = name.substring(0, period);
      if (next.indexOf("[") >= 0) {
        bean = getIndexedProperty(bean, next);
      }
      else {
        bean = getSimpleProperty(bean, next);
      }
      if (bean == null) {
        throw new IllegalArgumentException
            ("Null property value for '" +
             name.substring(0, period) + "'");
      }
      name = name.substring(period + 1);
    }

    if (name.indexOf("[") >= 0) {
      setIndexedProperty(bean, name, value);
    }
    else {
      setSimpleProperty(bean, name, value);

    }
  }

  /**
   * Set the value of the specified indexed property of the specified
   * bean, with no type conversions.  The zero-relative index of the
   * required value must be included (in square brackets) as a suffix to
   * the property name, or <code>IllegalArgumentException</code> will be
   * thrown.
   *
   * @param bean Bean whose property is to be modified
   * @param name <code>propertyname[index]</code> of the property value
   *  to be modified
   * @param value Value to which the specified property element
   *  should be set
   *
   * @exception IllegalAccessException if the caller does not have
   *  access to the property accessor method
   * @exception InvocationTargetException if the property accessor method
   *  throws an exception
   * @exception NoSuchMethodException if an accessor method for this
   *  propety cannot be found
   */
  public static void setIndexedProperty(Object bean, String name,
                                        Object value) throws
      IllegalAccessException, InvocationTargetException,
      NoSuchMethodException {

    // Identify the index of the requested individual property
    int left = name.indexOf("[");
    int right = name.indexOf("]");
    if ( (left < 0) || (right <= left)) {
      throw new IllegalArgumentException("Invalid indexed property '" +
                                         name + "'");
    }
    if (right > (name.length() - 1)) {
      throw new IllegalArgumentException("Invalid indexed property '" +
                                         name + "'");
    }
    int index = -1;
    try {
      String subscript = name.substring(left + 1, right);
      index = Integer.parseInt(subscript);
    }
    catch (NumberFormatException e) {
      throw new IllegalArgumentException("Invalid indexed property '" +
                                         name + "'");
    }
    name = name.substring(0, left);

    // Request the specified indexed property value
    setIndexedProperty(bean, name, index, value);

  }

  /**
   * Set the value of the specified indexed property of the specified
   * bean, with no type conversions.
   *
   * @param bean Bean whose property is to be set
   * @param name Simple property name of the property value to be set
   * @param index Index of the property value to be set
   * @param value Value to which the indexed property element is to be set
   *
   * @exception IllegalAccessException if the caller does not have
   *  access to the property accessor method
   * @exception InvocationTargetException if the property accessor method
   *  throws an exception
   * @exception NoSuchMethodException if an accessor method for this
   *  propety cannot be found
   */
  public static void setIndexedProperty(Object bean, String name,
                                        int index, Object value) throws
      IllegalAccessException, InvocationTargetException,
      NoSuchMethodException {

    // Retrieve the property descriptor for the specified property
    PropertyDescriptor descriptor =
        getPropertyDescriptor(bean, name);
    if (descriptor == null) {
      throw new NoSuchMethodException("Unknown property '" +
                                      name + "'");
    }

    // Call the indexed setter method if there is one
    if (descriptor instanceof IndexedPropertyDescriptor) {
      Method writeMethod = ( (IndexedPropertyDescriptor) descriptor).
          getIndexedWriteMethod();
      if (writeMethod != null) {
        Object subscript[] = new Object[2];
        subscript[0] = new Integer(index);
        subscript[1] = value;
        writeMethod.invoke(bean, subscript);
      }
    }

    // Otherwise, the underlying property must be an array
    Method readMethod = descriptor.getReadMethod();
    if (readMethod == null) {
      throw new NoSuchMethodException("Property '" + name +
                                      "' has no getter method");
    }

    // Call the property getter to get the array
    Object array = readMethod.invoke(bean, new Object[0]);
    if (!array.getClass().isArray()) {
      throw new IllegalArgumentException("Property '" + name +
                                         "' is not indexed");
    }

    // Modify the specified value
    Array.set(array, index, value);

  }

  /**
   * Set the value of the specified property of the specified bean,
   * no matter which property reference format is used, with no
   * type conversions.
   *
   * @param bean Bean whose property is to be modified
   * @param name Possibly indexed and/or nested name of the property
   *  to be modified
   * @param value Value to which this property is to be set
   *
   * @exception IllegalAccessException if the caller does not have
   *  access to the property accessor method
   * @exception InvocationTargetException if the property accessor method
   *  throws an exception
   * @exception NoSuchMethodException if an accessor method for this
   *  propety cannot be found
   */
  public static void setProperty(Object bean, String name, Object value) throws
      IllegalAccessException, InvocationTargetException,
      NoSuchMethodException {

    setNestedProperty(bean, name, value);

  }

  /**
   * Set the value of the specified simple property of the specified bean,
   * with no type conversions.
   *
   * @param bean Bean whose property is to be modified
   * @param name Name of the property to be modified
   * @param value Value to which the property should be set
   *
   * @exception IllegalAccessException if the caller does not have
   *  access to the property accessor method
   * @exception InvocationTargetException if the property accessor method
   *  throws an exception
   * @exception NoSuchMethodException if an accessor method for this
   *  propety cannot be found
   */
  public static void setSimpleProperty(Object bean,
                                       String name, Object value) throws
      IllegalAccessException, InvocationTargetException,
      NoSuchMethodException {

    // Retrieve the property setter method for the specified property
    PropertyDescriptor descriptor =
        getPropertyDescriptor(bean, name);
    if (descriptor == null) {
      throw new NoSuchMethodException("Unknown property '" +
                                      name + "'");
    }
    Method writeMethod = descriptor.getWriteMethod();
    if (writeMethod == null) {
      throw new NoSuchMethodException("Property '" + name +
                                      "' has no setter method");
    }

    // Call the property setter method
    Object values[] = new Object[1];
    values[0] = value;
    writeMethod.invoke(bean, values);

  }

}