com.alee.api.merge

Class Merge

java.lang.Object

com.alee.api.merge.Merge

All Implemented Interfaces:

Serializable

public final class Merge
extends Object
implements Serializable

Configurable algorithm for merging object instances. It can be customized through the settings provided in its constructor once on creation. To merge any two objects using this class instance call merge(Object, Object) method. To merge multiple objects using this class instance call merge(Object, Object, Object...) method. To merge all objects from a single collection using this class instance call merge(Collection) method.

Author:

Mikle Garin

See Also:

How to use Merge, NullResolver, UnknownResolver, GlobalMergeBehavior, MergeBehavior, Mergeable, Overwriting, Serialized Form

Constructor Summary

Constructors

Constructor and Description
Merge(ClonePolicy baseClonePolicy, ClonePolicy mergedClonePolicy, NullResolver nullResolver, UnknownResolver unknownResolver, GlobalMergeBehavior... behaviors) Constructs new Merge algorithm.
Merge(ClonePolicy baseClonePolicy, ClonePolicy mergedClonePolicy, NullResolver nullResolver, UnknownResolver unknownResolver, List<GlobalMergeBehavior> behaviors) Constructs new Merge algorithm.
Merge(NullResolver nullResolver, UnknownResolver unknownResolver, GlobalMergeBehavior... behaviors) Constructs new Merge algorithm.
Merge(NullResolver nullResolver, UnknownResolver unknownResolver, List<GlobalMergeBehavior> behaviors) Constructs new Merge algorithm.

Method Summary

Modifier and Type	Method and Description
static Merge	basic() Returns Merge algorithm that is able to merge basic object types.
static Merge	basicRaw() Returns Merge algorithm that is able to merge basic object types.
static Merge	deep() Returns Merge algorithm that can also merge custom objects through ReflectionMergeBehavior.
static Merge	deepRaw() Returns Merge algorithm that can also merge custom objects through ReflectionMergeBehavior.
<T> T	merge(Collection<?> objects) Performs merge of all provided objects and returns resulting object.
<T> T	merge(Object base, Object merged) Performs merge of the two provided objects and returns resulting object.
<T> T	merge(Object base, Object merged, Object... more) Performs merge of all provided objects and returns resulting object.
<T> T	nonNullMerge(Collection<?> objects) Performs merge of all provided objects and returns resulting non-null object.
<T> T	nonNullMerge(Object base, Object merged) Performs merge of the two provided objects and returns resulting non-null object.
<T> T	nonNullMerge(Object base, Object merged, Object... more) Performs merge of all provided objects and returns resulting non-null object.

Methods inherited from class java.lang.Object

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

Constructor Detail

Merge

public Merge(@NotNull
             NullResolver nullResolver,
             @NotNull
             UnknownResolver unknownResolver,
             @NotNull
             GlobalMergeBehavior... behaviors)

Constructs new Merge algorithm.

Parameters:

nullResolver - object merge null case resolver

unknownResolver - unknown object types case resolver

behaviors - behaviors taking part in this merge algorithm instance

Merge

public Merge(@NotNull
             ClonePolicy baseClonePolicy,
             @NotNull
             ClonePolicy mergedClonePolicy,
             @NotNull
             NullResolver nullResolver,
             @NotNull
             UnknownResolver unknownResolver,
             @NotNull
             GlobalMergeBehavior... behaviors)

Constructs new Merge algorithm.

Parameters:

baseClonePolicy - ClonePolicy for base object

mergedClonePolicy - ClonePolicy for merged objects

nullResolver - object merge null case resolver

unknownResolver - unknown object types case resolver

behaviors - behaviors taking part in this merge algorithm instance

Merge

public Merge(@NotNull
             NullResolver nullResolver,
             @NotNull
             UnknownResolver unknownResolver,
             @NotNull
             List<GlobalMergeBehavior> behaviors)

Constructs new Merge algorithm.

Parameters:

nullResolver - object merge null case resolver

unknownResolver - unknown object types case resolver

behaviors - behaviors taking part in this merge algorithm instance

Merge

public Merge(@NotNull
             ClonePolicy baseClonePolicy,
             @NotNull
             ClonePolicy mergedClonePolicy,
             @NotNull
             NullResolver nullResolver,
             @NotNull
             UnknownResolver unknownResolver,
             @NotNull
             List<GlobalMergeBehavior> behaviors)

Constructs new Merge algorithm.

Parameters:

baseClonePolicy - ClonePolicy for base object

mergedClonePolicy - ClonePolicy for merged objects

nullResolver - object merge null case resolver

unknownResolver - unknown object types case resolver

behaviors - behaviors taking part in this merge algorithm instance

Method Detail

merge

@Nullable
public <T> T merge(@Nullable
                             Object base,
                             @Nullable
                             Object merged)

Performs merge of the two provided objects and returns resulting object. Depending on the case it might be one of the two provided objects, their copy or their merge result. Whether or not base and/or merged will be copied depends on baseClonePolicy and mergedClonePolicy.

Type Parameters:

T - resulting object type

Parameters:

base - base object

merged - object to merge

Returns:

merge result

nonNullMerge

@NotNull
public <T> T nonNullMerge(@NotNull
                                   Object base,
                                   @NotNull
                                   Object merged)

Performs merge of the two provided objects and returns resulting non-null object. Depending on the case it might be one of the two provided objects, their copy or their merge result. Whether or not base and/or merged will be copied depends on baseClonePolicy and mergedClonePolicy.

Type Parameters:

T - resulting object type

Parameters:

base - base object

merged - object to merge

Returns:

non-null merge result

merge

@Nullable
public <T> T merge(@Nullable
                             Object base,
                             @Nullable
                             Object merged,
                             @NotNull
                             Object... more)

Performs merge of all provided objects and returns resulting object. Depending on the case it might be one of the two provided objects, their copy or their merge result. Whether or not base and/or merged will be copied depends on baseClonePolicy and mergedClonePolicy.

Type Parameters:

T - resulting object type

Parameters:

base - base object

merged - object to merge

more - more objects to merge

Returns:

merge result

nonNullMerge

@NotNull
public <T> T nonNullMerge(@NotNull
                                   Object base,
                                   @NotNull
                                   Object merged,
                                   @NotNull
                                   Object... more)

Performs merge of all provided objects and returns resulting non-null object. Depending on the case it might be one of the two provided objects, their copy or their merge result. Whether or not base and/or merged will be copied depends on baseClonePolicy and mergedClonePolicy.

Type Parameters:

T - resulting object type

Parameters:

base - base object

merged - object to merge

more - more objects to merge

Returns:

non-null merge result

merge

@Nullable
public <T> T merge(@NotNull
                             Collection<?> objects)

Performs merge of all provided objects and returns resulting object. Depending on the case it might be one of the provided objects, their copy or their merge result. Whether or not base and/or merged will be copied depends on baseClonePolicy and mergedClonePolicy.

Type Parameters:

T - resulting object type

Parameters:

objects - objects to merge

Returns:

merge result

nonNullMerge

@NotNull
public <T> T nonNullMerge(@NotNull
                                   Collection<?> objects)

Performs merge of all provided objects and returns resulting non-null object. Depending on the case it might be one of the provided objects, their copy or their merge result. Whether or not base and/or merged will be copied depends on baseClonePolicy and mergedClonePolicy.

Type Parameters:

T - resulting object type

Parameters:

objects - objects to merge

Returns:

non-null merge result

basic

@NotNull
public static Merge basic()

Returns Merge algorithm that is able to merge basic object types. It also creates copy for both base and merged objects before merging them together.

Returns:

Merge algorithm that is able to merge basic object types

basicRaw

@NotNull
public static Merge basicRaw()

Returns Merge algorithm that is able to merge basic object types.

Returns:

Merge algorithm that is able to merge basic object types

deep

@NotNull
public static Merge deep()

Returns Merge algorithm that can also merge custom objects through ReflectionMergeBehavior. Be careful when using this merge algorithm as it will go through all object references and will merge any existing fields. It also creates copy for both base and merged objects before merging them together.

Returns:

Merge algorithm that can also merge custom objects through ReflectionMergeBehavior

deepRaw

@NotNull
public static Merge deepRaw()

Returns Merge algorithm that can also merge custom objects through ReflectionMergeBehavior. Be careful when using this merge algorithm as it will go through all object references and will merge any existing fields.

Returns:

Merge algorithm that can also merge custom objects through ReflectionMergeBehavior