001    /**
002     * Copyright 2005-2013 The Kuali Foundation
003     *
004     * Licensed under the Educational Community 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.opensource.org/licenses/ecl2.php
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     */
016    package org.kuali.rice.krad.uif.component;
017    
018    import java.lang.annotation.Documented;
019    import java.lang.annotation.ElementType;
020    import java.lang.annotation.Retention;
021    import java.lang.annotation.RetentionPolicy;
022    import java.lang.annotation.Target;
023    
024    /**
025     * Annotation for <code>Component</code> fields to indicate only the property
026     * reference should be made (as opposed to a new object) when doing a component
027     * copy
028     *
029     * @author Kuali Rice Team (rice.collab@kuali.org)
030     */
031    @Target({ ElementType.FIELD })
032    @Retention(RetentionPolicy.RUNTIME)
033    @Documented
034    public @interface ReferenceCopy {
035    
036            /**
037             * Indicates whether a new collection instance should be made with
038             * collection elements copied by reference
039             *
040             * @return boolean true if new collection instance should be made, false if
041             *         the whole collection should be copied by reference
042             */
043            public boolean newCollectionInstance() default false;
044    
045    }