001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (https://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: https://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: https://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.ade.configuration;
029
030import org.opencms.util.CmsUUID;
031
032/**
033 * Simple immutable class for storing a custom content folder configuration.
034 *
035 * <p>There are two possibilities: Either a custom content folder should be used (then the corresponding instance
036 * of this class stores the folder id), or the default content folder should be used (in which case the folder id is null).
037 */
038public class CmsContentFolderOption {
039
040    /** The content folder id (may be null). */
041    private CmsUUID m_folderId;
042
043    /**
044     * Creates a new instance.
045     *
046     *
047     * @param contentFolderId the content folder id
048     */
049    public CmsContentFolderOption(CmsUUID contentFolderId) {
050
051        m_folderId = contentFolderId;
052    }
053
054    /**
055     * Gets the content folder id.
056     *
057     * <p>The result may be null.
058     *
059     * @return the content folder id
060     */
061    public CmsUUID getFolderId() {
062
063        return m_folderId;
064    }
065
066    /**
067     * Returns true if this represents the option to use the standard content folder.
068     *
069     * <p>This is currently implemented as the folder id being null.
070     *
071     * @return true if the default content folder should be used
072     */
073    public boolean isDefault() {
074
075        return m_folderId == null;
076    }
077
078}