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.file.quota;
029
030/**
031 * Options for reading folder size information.
032 */
033public class CmsFolderSizeOptions implements Cloneable {
034
035    /** The root path for which to read folder size information. */
036    private String m_rootPath;
037
038    /** True if we want folder size information for all folders in the subtree. */
039    private boolean m_tree;
040
041    private boolean m_online;
042
043    /**
044     * Creates a new instance.
045     *
046     * @param rootPath the root path for which to read the folder size information
047     * @param isTree true if we want folder size information for all folders in the subtree and not just the folder itself
048     */
049    public CmsFolderSizeOptions(String rootPath, boolean online, boolean isTree) {
050
051        m_rootPath = rootPath;
052        if (!m_rootPath.endsWith("/")) {
053            m_rootPath += "/";
054        }
055        m_online = online;
056        m_tree = isTree;
057    }
058
059    /**
060     * Gets the root path for which we want folder size information.
061     *
062     * @return the root path for which we want folder size information
063     */
064    public String getRootPath() {
065
066        return m_rootPath;
067    }
068
069    public boolean isOnline() {
070
071        return m_online;
072    }
073
074    /**
075     * True if we want to read folder size information for the complete subtree.
076     *
077     * @return true if we want to read folder size information for the complete subtree
078     */
079    public boolean isTree() {
080
081        return m_tree;
082    }
083
084}