Package org.apache.tapestry5.commons.services

Interface PropertyAdapter

  • All Superinterfaces:
    AnnotationProvider
    All Known Implementing Classes:
    PropertyAdapterImpl
    public interface PropertyAdapter
extends AnnotationProvider
    Provides access to a single property within a class. Acts as an AnnotationProvider; when searching for annotations, the read method (if present) is checked first, followed by the write method, followed by the underlying field (when the property name matches the field name). Starting in release 5.2, this property may actually be a public field. In 5.3, it may be a public static field.
    See Also:
    ClassPropertyAdapter

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      Object get​(Object instance)
      Reads the property value.
      Class getBeanType()
      Returns the type of bean to which this property belongs.
      ClassPropertyAdapter getClassAdapter()
      Returns the ClassPropertyAdapter that provides access to other properties defined by the same class.
      Class getDeclaringClass()
      The class in which the property (or public field) is defined.
      Field getField()
      Returns the field if the property is a public field or null if the property is accessed via the read method.
      String getName()
      Returns the name of the property (or public field).
      Method getReadMethod()
      Returns the method used to read the property, or null if the property is not readable (or is a public field).
      Class getType()
      Returns the type of the property.
      Method getWriteMethod()
      Returns the method used to update the property, or null if the property is not writeable (or a public field).
      boolean isCastRequired()
      Returns true if the return type of the read method is not the same as the property type.
      boolean isField()
      Returns true if the property is actually a public field (possibly, a public static field).
      boolean isRead()
      Returns true if the property is readable (i.e., has a getter method or is a public field).
      boolean isUpdate()
      Returns true if the property is writeable (i.e., has a setter method or is a non-final field).
      void set​(Object instance, Object value)
      Updates the property value.

    • Method Detail

      • getName

        String getName()
        Returns the name of the property (or public field).

      • isRead

        boolean isRead()
        Returns true if the property is readable (i.e., has a getter method or is a public field).

      • getReadMethod

        Method getReadMethod()
        Returns the method used to read the property, or null if the property is not readable (or is a public field).

      • isUpdate

        boolean isUpdate()
        Returns true if the property is writeable (i.e., has a setter method or is a non-final field).

      • getWriteMethod

        Method getWriteMethod()
        Returns the method used to update the property, or null if the property is not writeable (or a public field).

      • set

        void set​(Object instance,
         Object value)
        Updates the property value. The provided value must not be null if the property type is primitive, and must otherwise be of the proper type.
        Parameters:
        instance - to update
        value - new value for the property
        Throws:
        UnsupportedOperationException - if the property is read only

      • getType

        Class getType()
        Returns the type of the property.

      • isCastRequired

        boolean isCastRequired()
        Returns true if the return type of the read method is not the same as the property type. This can occur when the property has been defined using generics, in which case, the method's type may be Object when the property type is something more specific. This method is primarily used when generating runtime code related to the property.

      • isField

        boolean isField()
        Returns true if the property is actually a public field (possibly, a public static field).
        Since:
        5.2

      • getField

        Field getField()
        Returns the field if the property is a public field or null if the property is accessed via the read method.
        Since:
        5.2

      • getDeclaringClass

        Class getDeclaringClass()
        The class in which the property (or public field) is defined.
        Since:
        5.2