Package org.pipservices3.commons.reflect

Class ObjectReader

java.lang.Object
org.pipservices3.commons.reflect.ObjectReader
public class ObjectReader extends Object
Helper class to perform property introspection and dynamic reading.

In contrast to PropertyReflector which only introspects regular objects, this ObjectReader is also able to handle maps and arrays. For maps properties are key-pairs identified by string keys, For arrays properties are elements identified by integer index.

This class has symmetric implementation across all languages supported by Pip.Services toolkit and used to support dynamic data processing.

Because all languages have different casing and case sensitivity rules, this ObjectReader treats all property names as case insensitive.

### Example ### 

 
 MyObject myObj = new MyObject();
 
 List<String> properties = ObjectReader.getPropertyNames();
 ObjectReader.hasProperty(myObj, "myProperty");
 Object value = PropertyReflector.getProperty(myObj, "myProperty");
 
 Map<String, Object> myMap = new HashMap<String, Object>(){
  	{
  		put("key1", 123);
  		put("key2", "ABC");
  	}
 };
 ObjectReader.hasProperty(myMap, "key1");
 Object value = ObjectReader.getProperty(myMap, "key1");
 
 int[] myArray = new int[] {1, 2, 3};
 ObjectReader.hasProperty(myArrat, "0");
 Object value = ObjectReader.getProperty(myArray, "0");
See Also:

  • Constructor Details

    • ObjectReader

      public ObjectReader()

  • Method Details

    • getValue

      public static Object getValue(Object obj)
      Gets a real object value. If object is a wrapper, it unwraps the value behind it. Otherwise it returns the same object value.
      Parameters:
      obj - an object to unwrap..
      Returns:
      an actual (unwrapped) object value.

    • hasProperty

      public static boolean hasProperty(Object obj, String name)
      Checks if object has a property with specified name. The object can be a user defined object, map or array. The property name correspondently must be object property, map key or array index.
      Parameters:
      obj - an object to introspect.
      name - a name of the property to check.
      Returns:
      true if the object has the property and false if it doesn't.

    • getProperty

      public static Object getProperty(Object obj, String name)
      Gets value of object property specified by its name. The object can be a user defined object, map or array. The property name correspondently must be object property, map key or array index.
      Parameters:
      obj - an object to read property from.
      name - a name of the property to get.
      Returns:
      the property value or null if property doesn't exist or introspection failed.

    • getPropertyNames

      public static List<String> getPropertyNames(Object obj)
      Gets names of all properties implemented in specified object. The object can be a user defined object, map or array. Returned property name correspondently are object properties, map keys or array indexes.
      Parameters:
      obj - an objec to introspect.
      Returns:
      a list with property names.

    • getProperties

      public static Map<String,Object> getProperties(Object obj)
      Get values of all properties in specified object and returns them as a map. The object can be a user defined object, map or array. Returned properties correspondently are object properties, map key-pairs or array elements with their indexes.
      Parameters:
      obj - an object to get properties from.
      Returns:
      a map, containing the names of the object's properties and their values.