1 /**
2 * Copyright 2005-2014 The Kuali Foundation
3 *
4 * Licensed under the Educational Community License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.opensource.org/licenses/ecl2.php
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package org.kuali.rice.krad.uif.component;
17
18 import java.lang.annotation.Documented;
19 import java.lang.annotation.ElementType;
20 import java.lang.annotation.Retention;
21 import java.lang.annotation.RetentionPolicy;
22 import java.lang.annotation.Target;
23 import java.util.List;
24
25 import org.kuali.rice.krad.datadictionary.Copyable;
26 import org.kuali.rice.krad.uif.util.LifecycleAwareList;
27
28 /**
29 * Annotation for {@link Copyable} fields to indicate that a delayed copy proxy should be used
30 * instead of the original component when performing a deep copying on the field.
31 *
32 * @author Kuali Rice Team (rice.collab@kuali.org)
33 */
34 @Target({ElementType.FIELD})
35 @Retention(RetentionPolicy.RUNTIME)
36 @Documented
37 public @interface DelayedCopy {
38
39 /**
40 * May be used to indicate the presence of this annotation on the field referring to the object
41 * should be used to determine if this field should be delayed.
42 *
43 * <p>
44 * For example, {@link LifecycleAwareList} is a delegating list wrapper and since it implements
45 * the {@link List} interface is treated as a {@link List} rather than a {@link Copyable} when
46 * performing a deep copy. The presence of {@DelayedCopy} with {@link #inherit()}
47 * set to true on the delegate indicates that the items in the delegated list should be delayed
48 * only if the undelegated list reference also has the {@link DelayedCopy} annotation.
49 * </p>
50 *
51 * @return True if the parent field determines whether or not to delay copying the field, false
52 * to always delay copy of the annotated field.
53 */
54 boolean inherit() default false;
55
56 }