001/**
002 * Copyright 2005-2016 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
018/**
019 * Defines different context(s) for serialization in Rice.
020 *
021 * @author Kuali Rice Team (rice.collab@kuali.org)
022 */
023public enum SerializationContext {
024
025    /**
026     * Matches all the other contexts defined in {@link SerializationContext}.
027     */
028    ALL,
029
030    /**
031     * The context for serializing within the maintenance document framework.
032     */
033    MAINTENANCE;
034
035// TODO: implement respect for @Serialized in workflow doc serialization
036//    /**
037//     * The context for serializing to workflow document contents.
038//     */
039//    WORKFLOW;
040
041    /**
042     * Does the given array of serializationContexts match this one?
043     *
044     * <p>Either an exact match, or SerializationContext.ALL will suffice</p>
045     *
046     * @param serializationContexts the serializationContexts to test against
047     * @return true if there is a matching context
048     */
049    public boolean matches(SerializationContext [] serializationContexts) {
050        if (serializationContexts != null) for (SerializationContext serializationContext : serializationContexts) {
051            if (serializationContext == this || serializationContext == SerializationContext.ALL) {
052                return true;
053            }
054        }
055
056        return false;
057    }
058}