Methods Guide

Methods Reference

Here is the full reference for Mapper.

Rename Input Objects

We use below methods to rename input objects, so that we can reference them in the Field Mapper Key expressions.

Example:

new Mapper()
    .inputAs('src1', src2)
    .mapField('x', 'src1.x')
    .mapField('y', 'src2.y')
    .toMap();

If there is only one source object, we don't need to use inputAs.

Map Fields

We have various methods to add field mappings to the Mapper.

Example:

new Mapper()
    .mapFields(new Map{
        'x' => new Mapper.FieldMapper('a', R.identity),
        'y' => 'b',
        'c' => R.identity
    });

When using mapFields, the values in the field mapper map can be:

• FieldMapper, which will be used to map the field
• String, the Field Mapper key
• Func, the transformer to process the value

Reverse Mapper

For mappers that contain only one-to-one field mappers and do not have any names set from inputAs, we can easily create their reverse mappers.

Mapper reversed = m.reverseToMap();

Here we have a list of methods to specify the exact type of object the reversed mapper converts to.

Specify Convert To

We need to specify which type the mapper will convert the object to.

new Mapper()
    .mapField('name', 'Name')
    .toObject(AccountDTO.class);

Here is a list of methods that we can use: