001/**
002 * Copyright 2005-2014 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 */
016package org.kuali.rice.krad.data.provider.annotation;
017
018import java.lang.annotation.Documented;
019import java.lang.annotation.ElementType;
020import java.lang.annotation.Retention;
021import java.lang.annotation.RetentionPolicy;
022import java.lang.annotation.Target;
023
024/**
025 * Indicates whether the attribute contents should be serialized in the given context(s).
026 *
027 * @author Kuali Rice Team (rice.collab@kuali.org)
028 */
029@Target(ElementType.FIELD)
030@Retention(RetentionPolicy.RUNTIME)
031@Documented
032public @interface Serialized {
033
034    /**
035     * If true, this indicates that the marked field should be serialized for the indicated contexts, and if false
036     * then the marked field should not.
037     *
038     * @return whether the marked field should be serialized
039     */
040    boolean enabled() default true;
041
042    /**
043     * The serialization contexts that {@link Serialized} applies to.
044     *
045     * @return the serialization contexts
046     */
047    SerializationContext[] forContexts() default { SerializationContext.ALL };
048}