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.FIELD;
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.BasicCloner;
026
027/**
028 * Applied to a field, this annotation indicates that the field should be considered
029 * to be transient when performing a clone. Transient fields when configured in {@link BasicCloner}
030 * will be given the null or default values. If you simply want to retain the transient field without
031 * copying, register it as {@link Immutable} or {@link NonCloneable} as appropriate. 
032 */
033@Retention(RUNTIME) @Target({FIELD})
034@Documented
035public @interface Transient {
036}