001/*
002 *  Copyright 2013 Chris Pheby
003 *
004 *  Licensed under the Apache License, Version 2.0 (the "License");
005 *  you may not use this file except in compliance with the License.
006 *  You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *  Unless required by applicable law or agreed to in writing, software
011 *  distributed under the License is distributed on an "AS IS" BASIS,
012 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *  See the License for the specific language governing permissions and
014 *  limitations under the License.
015 */
016package org.jadira.reflection.cloning.annotation;
017
018import static java.lang.annotation.ElementType.TYPE;
019import static java.lang.annotation.RetentionPolicy.RUNTIME;
020
021import java.lang.annotation.Documented;
022import java.lang.annotation.Retention;
023import java.lang.annotation.Target;
024
025import org.jadira.reflection.cloning.api.CloneImplementor;
026import org.jadira.reflection.cloning.api.NoCloneImplementor;
027
028/**
029 * This annotation can be applied to classes to indicate that they may be cloned. In practice
030 * the use of this annotation is not mandatory as all classes can effectively be cloned by the cloning library. <br>
031 * There are benefits to using this annotation however, as it allows the cloning behaviour for the annotated class to be
032 * customised.
033 */
034@Retention(RUNTIME)
035@Target({ TYPE })
036@Documented
037public @interface Cloneable {
038
039        /**
040         * An optional reference to a class that extends CloneImplementor. If provided the specified CloneImplementor
041         * will be used to override the standard cloning behaviour
042         * @return The CloneImplementor class to be used
043         */
044    Class<? extends CloneImplementor> implementor() default NoCloneImplementor.class;
045}