org.ikasan.flow.event.ClonerReplicationFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ikasan-flow-visitorPattern Show documentation
Ikasan EIP Flow implementation based on the Visitor design pattern
The newest version!
/*
 * $Id$
 * $URL$
 * 
 * ====================================================================
 * Ikasan Enterprise Integration Platform
 * 
 * Distributed under the Modified BSD License.
 * Copyright notice: The copyright for this software and a full listing 
 * of individual contributors are as shown in the packaged copyright.txt 
 * file. 
 * 
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without 
 * modification, are permitted provided that the following conditions are met:
 *
 *  - Redistributions of source code must retain the above copyright notice, 
 *    this list of conditions and the following disclaimer.
 *
 *  - Redistributions in binary form must reproduce the above copyright notice, 
 *    this list of conditions and the following disclaimer in the documentation 
 *    and/or other materials provided with the distribution.
 *
 *  - Neither the name of the ORGANIZATION nor the names of its contributors may
 *    be used to endorse or promote products derived from this software without 
 *    specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE 
 * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * ====================================================================
 */
package org.ikasan.flow.event;

import org.ikasan.spec.event.ReplicationFactory;

import com.rits.cloning.Cloner;

/**
 * Implementation of the replicationFactory contract.
 * 
 * @author Ikasan Development Team
 *
 */
public class ClonerReplicationFactory implements ReplicationFactory
{
    /** Implementation of the replication class */
    private Cloner cloner;
    
    /**
     * Constructor
     * @param cloner
     */
	public ClonerReplicationFactory(Cloner cloner)
	{
	    this.cloner = cloner;
	    if(cloner == null)
	    {
	        throw new IllegalArgumentException("Cloner cannot be 'null'");
	    }
	}
	
	/**
	 * Return a completely independent deep copy instance of the incoming object. The
	 * returned object can be freely mutated without any consequential changes
	 * being made to the originating object.
	 * 
	 * @param object to be replicated
	 * @return deep replicated object
	 */
	public T replicate(T object)
	{
        // TODO - find a way to control the deep clone to avoid JVM crashes at runtime
	    return cloner.deepClone(object);
	}

    /**
     * Return a completely independent shallow copy instance of the incoming object. The
     * returned object CANNOT be freely mutated without any consequential changes
     * being made to the originating object.
     *
     * Use with care - the returned object may share references with the original object.
     *
     * @param object to be replicated
     * @return shallow replicated object
     */
    public T shallowReplicate(T object)
    {
        return cloner.shallowClone(object);
    }
}