001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.xml.content;
029
030import org.opencms.xml.content.I_CmsXmlContentHandler.SynchronizationMode;
031
032import java.util.Collections;
033import java.util.LinkedHashMap;
034import java.util.Map;
035import java.util.Set;
036
037import com.google.common.collect.Maps;
038
039/**
040 * A class representing the value synchronization configuration from a schema (or set of schemas).
041 */
042public class CmsSynchronizationSpec {
043
044    /** Map from xpaths to synchronization modes. */
045    private LinkedHashMap<String, SynchronizationMode> m_synchMap;
046
047    /**
048     * Creates a new instance based on a map of synchronization modes.
049     * <p>Note the map given as argument is used as-is and not copied, so modifying it later may lead to problems.
050     *
051     * @param synchMap the map of synchronization modes
052     */
053    public CmsSynchronizationSpec(LinkedHashMap<String, SynchronizationMode> synchMap) {
054
055        m_synchMap = synchMap;
056    }
057
058    /**
059     * Gets an immutable map view of the synchronizations mode by xpath.
060     *
061     * @return a map from xpaths to synchronization modes
062     */
063    public Map<String, SynchronizationMode> asMap() {
064
065        return Collections.unmodifiableMap(m_synchMap);
066    }
067
068    /**
069     * Gets the set of paths for which synchronization is turned on in this configuration.
070     *
071     * @return the set of synchronization paths
072     */
073    public Set<String> getSynchronizationPaths() {
074
075        return Collections.unmodifiableSet(
076            Maps.filterEntries(m_synchMap, entry -> entry.getValue() != SynchronizationMode.none).keySet());
077
078    }
079
080}