001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.collections4.functors;
018
019import org.apache.commons.collections4.Transformer;
020
021/**
022 * Transformer implementation that returns a clone of the input object.
023 * <p>
024 * Clone is performed using <code>PrototypeFactory.prototypeFactory(input).create()</code>.
025 * <p>
026 * <b>WARNING:</b> from v4.1 onwards this class will <b>not</b> be serializable anymore
027 * in order to prevent potential remote code execution exploits. Please refer to
028 * <a href="https://issues.apache.org/jira/browse/COLLECTIONS-580">COLLECTIONS-580</a>
029 * for more details.
030 *
031 * @since 3.0
032 * @version $Id: CloneTransformer.html 972397 2015-11-14 15:01:49Z tn $
033 */
034public class CloneTransformer<T> implements Transformer<T, T> {
035
036    /** Singleton predicate instance */
037    @SuppressWarnings("rawtypes") // the singleton instance works for all types
038    public static final Transformer INSTANCE = new CloneTransformer<Object>();
039
040    /**
041     * Factory returning the singleton instance.
042     *
043     * @param <T>  the type of the objects to be cloned
044     * @return the singleton instance
045     * @since 3.1
046     */
047    @SuppressWarnings("unchecked") // the singleton instance works for all types
048    public static <T> Transformer<T, T> cloneTransformer() {
049        return INSTANCE;
050    }
051
052    /**
053     * Constructor.
054     */
055    private CloneTransformer() {
056        super();
057    }
058
059    /**
060     * Transforms the input to result by cloning it.
061     *
062     * @param input  the input object to transform
063     * @return the transformed result
064     */
065    @Override
066    public T transform(final T input) {
067        if (input == null) {
068            return null;
069        }
070        return PrototypeFactory.prototypeFactory(input).create();
071    }
072
073}