001    /* ====================================================================
002     * The Apache Software License, Version 1.1
003     *
004     * Copyright (c) 2003 The Apache Software Foundation.  All rights
005     * reserved.
006     *
007     * Redistribution and use in source and binary forms, with or without
008     * modification, are permitted provided that the following conditions
009     * are met:
010     *
011     * 1. Redistributions of source code must retain the above copyright
012     *    notice, this list of conditions and the following disclaimer.
013     *
014     * 2. Redistributions in binary form must reproduce the above copyright
015     *    notice, this list of conditions and the following disclaimer in
016     *    the documentation and/or other materials provided with the
017     *    distribution.
018     *
019     * 3. The end-user documentation included with the redistribution,
020     *    if any, must include the following acknowledgment:
021     *       "This product includes software developed by the
022     *        Apache Software Foundation (http://www.apache.org/)."
023     *    Alternately, this acknowledgment may appear in the software itself,
024     *    if and wherever such third-party acknowledgments normally appear.
025     *
026     * 4. The names "The Jakarta Project", "Commons", and "Apache Software
027     *    Foundation" must not be used to endorse or promote products derived
028     *    from this software without prior written permission. For written
029     *    permission, please contact apache@apache.org.
030     *
031     * 5. Products derived from this software may not be called "Apache",
032     *    nor may "Apache" appear in their name, without prior written
033     *    permission of the Apache Software Foundation.
034     *
035     * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
036     * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
037     * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
038     * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
039     * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
040     * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
041     * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
042     * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
043     * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
044     * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
045     * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
046     * SUCH DAMAGE.
047     * ====================================================================
048     *
049     * This software consists of voluntary contributions made by many
050     * individuals on behalf of the Apache Software Foundation.  For more
051     * information on the Apache Software Foundation, please see
052     * <http://www.apache.org/>.
053     *
054     */
055    package org.jpu.patterns.common;
056    
057    import java.io.Serializable;
058    import java.lang.reflect.Method;
059    
060    import org.apache.commons.lang.SerializationUtils;
061    import org.apache.commons.lang.exception.NestableRuntimeException;
062    import org.apache.commons.logging.Log;
063    import org.apache.commons.logging.LogFactory;
064    
065    public class JPUObjectUtils {
066        private JPUObjectUtils() {} 
067    
068        /**
069         * Alias for "<code>cloneObjectEfficiently(o, "clone")</code>".
070         */
071        public static Object cloneObjectEfficiently(Object o) {
072            return cloneObjectEfficiently(o, "clone");
073        }
074    
075        /**
076         * First attempts to clone the object using a public clone method with the specified name; if 
077         * that fails it falls back to <code>SerializationUtils.clone()</code> (which is <i><b><u>much</u></b></i> 
078         * slower); if that fails, throws a
079         * NestableRuntimeException holding the resulting exception.
080         */
081        public static Object cloneObjectEfficiently(Object o, String methodName) {
082            if ( o == null ) {
083                return null;
084            }
085            if ( _log.isDebugEnabled() ) {
086                _log.debug( "Cloning a " + o.getClass().getName() );
087            }
088            Class c = o.getClass();
089    
090            Object result = null;
091            try {
092                Method m = c.getMethod(methodName, new Class[0]);
093                result = m.invoke(o, new Object[0]);
094            }
095            catch( NoSuchMethodException e ) {
096                if ( o instanceof Serializable ) {
097                    if ( _log.isDebugEnabled() ) {
098                        _log.debug( "Using SerializationUtils.clone() on an instance of " + o.getClass().getName() + " because [" + e + "].  This method of cloning is slow and will reduce performance considerably." );
099                    }
100                    result = SerializationUtils.clone( (Serializable)o );
101                }
102                else {
103                    throw new NestableRuntimeException(e);
104                }
105            }
106            catch(Exception e) {
107                throw new NestableRuntimeException(e);
108            }
109            return result;
110        }
111    
112        private static Log _log = LogFactory.getLog(JPUObjectUtils.class); 
113    }
114