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