Package org.assertj.core.util.introspection

Class PropertySupport

  • public class PropertySupport
extends java.lang.Object
    Utility methods for properties access.

    • Constructor Summary

      Constructors 
      Constructor Description
      PropertySupport()  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static PropertySupport instance()
      Returns the singleton instance of this class.
      private boolean isNestedProperty​(java.lang.String propertyName)  
      private java.lang.String nextPropertyNameFrom​(java.lang.String propertyNameChain)  
      private java.lang.String popPropertyNameFrom​(java.lang.String propertyNameChain)  
      <T> T propertyValue​(java.lang.String propertyName, java.lang.Class<T> clazz, java.lang.Object target)
      Return the value of a simple property from a target object.
      <T> T propertyValueOf​(java.lang.String propertyName, java.lang.Class<T> clazz, java.lang.Object target)
      Returns the value of the given property name given target.
      static <T> T propertyValueOf​(java.lang.String propertyName, java.lang.Object target, java.lang.Class<T> clazz)
      Static variant of propertyValueOf(String, Class, Object) for syntactic sugar.
      <T> java.util.List<T> propertyValues​(java.lang.String propertyName, java.lang.Class<T> clazz, java.lang.Iterable<?> target)
      Returns a List containing the values of the given property name, from the elements of the given Iterable.
      java.util.List<java.lang.Object> propertyValues​(java.lang.String fieldOrPropertyName, java.lang.Iterable<?> target)
      Returns a List containing the values of the given property name, from the elements of the given Iterable.
      boolean publicGetterExistsFor​(java.lang.String fieldName, java.lang.Object actual)  
      private <T> java.util.List<T> simplePropertyValues​(java.lang.String propertyName, java.lang.Class<T> clazz, java.lang.Iterable<?> target)  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • PropertySupport

        PropertySupport()

    • Method Detail

      • instance

        public static PropertySupport instance()
        Returns the singleton instance of this class.
        Returns:
        the singleton instance of this class.

      • propertyValues

        public <T> java.util.List<T> propertyValues​(java.lang.String propertyName,
                                            java.lang.Class<T> clazz,
                                            java.lang.Iterable<?> target)
        Returns a List containing the values of the given property name, from the elements of the given Iterable. If the given Iterable is empty or null, this method will return an empty List. This method supports nested properties (e.g. "address.street.number").
        Type Parameters:
        T - the type of the extracted elements.
        Parameters:
        propertyName - the name of the property. It may be a nested property. It is left to the clients to validate for null or empty.
        clazz - type of property
        target - the given Iterable.
        Returns:
        an Iterable containing the values of the given property name, from the elements of the given Iterable.
        Throws:
        IntrospectionError - if an element in the given Iterable does not have a property with a matching name.

      • propertyValueOf

        public static <T> T propertyValueOf​(java.lang.String propertyName,
                                    java.lang.Object target,
                                    java.lang.Class<T> clazz)
        Static variant of propertyValueOf(String, Class, Object) for syntactic sugar.
        Type Parameters:
        T - the type of the extracted elements.
        Parameters:
        propertyName - the name of the property. It may be a nested property. It is left to the clients to validate for null or empty.
        target - the given object
        clazz - type of property
        Returns:
        a the values of the given property name
        Throws:
        IntrospectionError - if the given target does not have a property with a matching name.

      • simplePropertyValues

        private <T> java.util.List<T> simplePropertyValues​(java.lang.String propertyName,
                                                   java.lang.Class<T> clazz,
                                                   java.lang.Iterable<?> target)

      • popPropertyNameFrom

        private java.lang.String popPropertyNameFrom​(java.lang.String propertyNameChain)

      • nextPropertyNameFrom

        private java.lang.String nextPropertyNameFrom​(java.lang.String propertyNameChain)

      • isNestedProperty

        private boolean isNestedProperty​(java.lang.String propertyName)

      • propertyValue

        public <T> T propertyValue​(java.lang.String propertyName,
                           java.lang.Class<T> clazz,
                           java.lang.Object target)
        Return the value of a simple property from a target object.

        This only works for simple property, nested property are not supported ! use propertyValueOf(String, Class, Object)

        Type Parameters:
        T - the type of the extracted value.
        Parameters:
        propertyName - the name of the property. It may be a nested property. It is left to the clients to validate for null or empty.
        target - the given object
        clazz - type of property
        Returns:
        a the values of the given property name
        Throws:
        IntrospectionError - if the given target does not have a property with a matching name.

      • propertyValueOf

        public <T> T propertyValueOf​(java.lang.String propertyName,
                             java.lang.Class<T> clazz,
                             java.lang.Object target)
        Returns the value of the given property name given target. If the given object is null, this method will return null.
        This method supports nested properties (e.g. "address.street.number").
        Type Parameters:
        T - the type of the extracted value.
        Parameters:
        propertyName - the name of the property. It may be a nested property. It is left to the clients to validate for null or empty.
        clazz - the class of property.
        target - the given Object to extract property from.
        Returns:
        the value of the given property name given target.
        Throws:
        IntrospectionError - if target object does not have a property with a matching name.
        java.lang.IllegalArgumentException - if propertyName is null.

      • propertyValues

        public java.util.List<java.lang.Object> propertyValues​(java.lang.String fieldOrPropertyName,
                                                       java.lang.Iterable<?> target)
        Returns a List containing the values of the given property name, from the elements of the given Iterable. If the given Iterable is empty or null, this method will return an empty List. This method supports nested properties (e.g. "address.street.number").
        Parameters:
        fieldOrPropertyName - the name of the property. It may be a nested property. It is left to the clients to validate for null or empty.
        target - the given Iterable.
        Returns:
        an Iterable containing the values of the given property name, from the elements of the given Iterable.
        Throws:
        IntrospectionError - if an element in the given Iterable does not have a property with a matching name.

      • publicGetterExistsFor

        public boolean publicGetterExistsFor​(java.lang.String fieldName,
                                     java.lang.Object actual)