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.data.provider.annotation;
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 * Indicates whether the attribute contents should be serialized in the given context(s).
26 *
27 * @author Kuali Rice Team (rice.collab@kuali.org)
28 */
29 @Target(ElementType.FIELD)
30 @Retention(RetentionPolicy.RUNTIME)
31 @Documented
32 public @interface Serialized {
33
34 /**
35 * If true, this indicates that the marked field should be serialized for the indicated contexts, and if false
36 * then the marked field should not.
37 *
38 * @return whether the marked field should be serialized
39 */
40 boolean enabled() default true;
41
42 /**
43 * The serialization contexts that {@link Serialized} applies to.
44 *
45 * @return the serialization contexts
46 */
47 SerializationContext[] forContexts() default { SerializationContext.ALL };
48 }