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
24 /**
25 * Annotation for <code>Component</code> fields to indicate only the property
26 * reference should be made (as opposed to a new object) when doing a component
27 * copy
28 *
29 * @author Kuali Rice Team (rice.collab@kuali.org)
30 */
31 @Target({ ElementType.FIELD })
32 @Retention(RetentionPolicy.RUNTIME)
33 @Documented
34 public @interface ReferenceCopy {
35
36 /**
37 * Indicates whether a new collection instance should be made with
38 * collection elements copied by reference
39 *
40 * @return boolean true if new collection instance should be made, false if
41 * the whole collection should be copied by reference
42 */
43 boolean newCollectionInstance() default false;
44
45 /**
46 * Indicates that a field should be omitted from copying.
47 *
48 * @return true if the field should be omitted from copying, false to follow
49 * {@link #newCollectionInstance()} semantics.
50 */
51 boolean referenceTransient() default false;
52
53 }