com.github.erchu.beancp.commons

Class NameBasedMapConvention

java.lang.Object

com.github.erchu.beancp.commons.NameBasedMapConvention

All Implemented Interfaces:

MapConvention

public class NameBasedMapConvention
extends Object
implements MapConvention

Convention matches fields by name.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NameBasedMapConvention() Constructs instance.

Method Summary

Modifier and Type	Method and Description
NameBasedMapConvention	disableFlattening() Disables flattening feature as described in enableFlattening() method.
NameBasedMapConvention	enableFlattening() Enables flattening feature.
NameBasedMapConvention	excludeDestinationMembers(String... members) Sets list of destination members which will be excluded (ignored) by convention.
NameBasedMapConvention	failIfNotAllDestinationMembersMapped() Convention will fail during map building (see getBindings(com.github.erchu.beancp.MappingInfo, java.lang.Class, java.lang.Class) method) if not all destination properties are mapped.
NameBasedMapConvention	failIfNotAllSourceMembersMapped() Convention will fail during map building (see getBindings(com.github.erchu.beancp.MappingInfo, java.lang.Class, java.lang.Class) method) if not all source properties are mapped.
static NameBasedMapConvention	get() Returns mapping convention with following configuration No destination members excluded Maximum possible number of destination members included Will not fail if not all destination members are mapped Will not fail if not all source members are mapped Flattening feature disabled
List<Binding>	getBindings(MappingInfo mappingsInfo, Class sourceClass, Class destinationClass) Returns list o bindings for specified source and destination classes.
NameBasedMapConvention	includeDestinationMembers(String... members) Sets list of destination members which will be included to matching.

Methods inherited from class java.lang.Object

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

Constructor Detail

NameBasedMapConvention

protected NameBasedMapConvention()

Constructs instance.

Method Detail

get

public static NameBasedMapConvention get()

Returns mapping convention with following configuration

• No destination members excluded
• Maximum possible number of destination members included
• Will not fail if not all destination members are mapped
• Will not fail if not all source members are mapped
• Flattening feature disabled

Returns:

mapping convention.

includeDestinationMembers

public NameBasedMapConvention includeDestinationMembers(String... members)

Sets list of destination members which will be included to matching. Each entry must be regular expression matching field name or bean property name (according to beans specification). If not specified (empty array) all members are subject to map by convention. If specified (not empty array) only members with names matching any of members could be mapped by convention ignoring case. This list has lower priority that exclude list specified by excludeDestinationMembers(java.lang.String...) method.

Note that when you put some member on list then it is not guaranteed that it will be mapped — it still have to have matching source's member according to convention configuration.

Parameters:

members - members to include

Returns:

this (for method chaining)

excludeDestinationMembers

public NameBasedMapConvention excludeDestinationMembers(String... members)

Sets list of destination members which will be excluded (ignored) by convention. Each entry must be regular expression matching field name or bean property name (according to beans specification). This list has higher priority that include list specified by includeDestinationMembers(java.lang.String...) method.

Note that when you put some member on list then it is not guaranteed that it will be mapped — it still have to have matching source's member according to convention configuration.

Parameters:

members - members to ignore

Returns:

this (for method chaining)

enableFlattening

public NameBasedMapConvention enableFlattening()

Enables flattening feature. This feature will try to match members from nested classes only if no direct member can be matched. This is useful if you have complex model to be mapped to simpler one. Destination member will be matched to source nested class member if destination member's name parts match path to source member. For example: for below classes setCustomerName will be matched to getCustomer().getName() because CustomerName property can be interpreted as path to Customer and then to Name property.

 class Customer {

     private String name;

     public String getName() {
          return name;
     }
 }

 class Order {

     private Customer customer;

     public Customer getCustomer() {
          return customer;
     }
 }

 class OrderDto {

     private String customerName;

     public void setCustomerName(final String customerName) {
          customerName = customerName;
     }

     public String getCustomerName() {
          return customerName;
     }
 }
 

This feature can be disabled by disableFlattening() method.

Returns:

this (for method chaining)

disableFlattening

public NameBasedMapConvention disableFlattening()

Disables flattening feature as described in enableFlattening() method. This is opposite to enableFlattening() method.

Returns:

this (for method chaining)

failIfNotAllDestinationMembersMapped

public NameBasedMapConvention failIfNotAllDestinationMembersMapped()

Convention will fail during map building (see getBindings(com.github.erchu.beancp.MappingInfo, java.lang.Class, java.lang.Class) method) if not all destination properties are mapped.

Returns:

this (for method chaining)

failIfNotAllSourceMembersMapped

public NameBasedMapConvention failIfNotAllSourceMembersMapped()

Convention will fail during map building (see getBindings(com.github.erchu.beancp.MappingInfo, java.lang.Class, java.lang.Class) method) if not all source properties are mapped.

Returns:

this (for method chaining)

getBindings

public List<Binding> getBindings(MappingInfo mappingsInfo,
                                 Class sourceClass,
                                 Class destinationClass)

Description copied from interface: MapConvention

Returns list o bindings for specified source and destination classes. Must be thread-safe.

Specified by:

getBindings in interface MapConvention

Parameters:

mappingsInfo - current mapping information.

sourceClass - source class.

destinationClass - destination class.

Returns:

found bindings.