Package org.pipservices3.commons.reflect

Class ObjectWriter

java.lang.Object

org.pipservices3.commons.reflect.ObjectWriter

public class ObjectWriter
extends Object

Helper class to perform property introspection and dynamic writing.

In contrast to PropertyReflector which only introspects regular objects, this ObjectWriter 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 ObjectWriter treats all property names as case insensitive.

### Example ###

 
 MyObject myObj = new MyObject();

 ObjectWriter.setProperty(myObj, "myProperty", 123);

 Map<String, Object> myMap = new HashMap<String, Object>(){
    {
  		put("key1", 123);
  		put("key2", "ABC");
    }
 };
 ObjectWriter.setProperty(myMap, "key1", "XYZ");

 int[] myArray = new int[] {1, 2, 3};
 ObjectWriter.setProperty(myArray, "0", 123);
 
 

See Also:

• PropertyReflector

Constructor Summary

Constructors

Constructor	Description
ObjectWriter()

Method Summary

Modifier and Type	Method	Description
static void	setProperties(Object obj, Map<String,Object> values)	Sets values of some (all) object properties.
static void	setProperty(Object obj, String name, Object value)	Sets value of object property specified by its name.

Methods inherited from class java.lang.Object

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

Constructor Details

ObjectWriter

public ObjectWriter()

Method Details

setProperty

public static void setProperty(Object obj,
 String name,
 Object value)

Sets 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.

If the property does not exist or introspection fails this method doesn't do anything and doesn't any throw errors.

Parameters:

obj - an object to write property to.

name - a name of the property to set.

value - a new value for the property to set.

setProperties

public static void setProperties(Object obj,
 Map<String,Object> values)

Sets values of some (all) object properties.

The object can be a user defined object, map or array. Property values correspondently are object properties, map key-pairs or array elements with their indexes.

If some properties do not exist or introspection fails they are just silently skipped and no errors thrown.

Parameters:

obj - an object to write properties to.

values - a map, containing property names and their values.

See Also:

• setProperty(Object, String, Object)