001/* 002 * (C) Copyright 2006-2011 Nuxeo SA (http://nuxeo.com/) and others. 003 * 004 * Licensed under the Apache 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.apache.org/licenses/LICENSE-2.0 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 * Contributors: 017 * Laurent Doguin 018 */ 019package org.nuxeo.ecm.core.versioning; 020 021import java.io.Serializable; 022import java.util.HashMap; 023import java.util.Map; 024 025import org.nuxeo.common.xmap.annotation.XNode; 026import org.nuxeo.common.xmap.annotation.XNodeMap; 027import org.nuxeo.common.xmap.annotation.XObject; 028 029/** 030 * Descriptor to contribute new versioning rules. 031 * 032 * @author Laurent Doguin 033 * @since 5.4.2 034 */ 035@XObject("versioningRule") 036public class VersioningRuleDescriptor implements Serializable { 037 038 private static final long serialVersionUID = 1L; 039 040 @XNode("@enabled") 041 protected Boolean enabled; 042 043 @XNodeMap(value = "options", key = "@lifeCycleState", type = HashMap.class, componentType = SaveOptionsDescriptor.class) 044 public Map<String, SaveOptionsDescriptor> options = new HashMap<String, SaveOptionsDescriptor>(); 045 046 @XNode("initialState") 047 public InitialStateDescriptor initialState; 048 049 @XNode("@typeName") 050 protected String typeName; 051 052 /** True if the boolean is null or TRUE, false otherwise. */ 053 private static boolean defaultTrue(Boolean bool) { 054 return !Boolean.FALSE.equals(bool); 055 } 056 057 public boolean isEnabled() { 058 return defaultTrue(enabled); 059 } 060 061 public String getTypeName() { 062 return typeName; 063 } 064 065 public Map<String, SaveOptionsDescriptor> getOptions() { 066 return options; 067 } 068 069 public InitialStateDescriptor getInitialState() { 070 return initialState; 071 } 072 073 /** Empty constructor. */ 074 public VersioningRuleDescriptor() { 075 } 076 077 /** Copy constructor. */ 078 public VersioningRuleDescriptor(VersioningRuleDescriptor other) { 079 this.enabled = other.enabled; 080 this.typeName = other.typeName; 081 this.options = other.options; 082 this.initialState = other.initialState; 083 } 084 085 public void merge(VersioningRuleDescriptor other) { 086 if (other.enabled != null) { 087 enabled = other.enabled; 088 } 089 if (other.typeName != null) { 090 typeName = other.typeName; 091 } 092 options.putAll(other.options); // always merge options TODO override flag 093 if (other.initialState != null) { 094 initialState = other.initialState; 095 } 096 } 097 098}