Package org.opencms.file.quota

Class CmsFolderSizeOptions

java.lang.Object

org.opencms.file.quota.CmsFolderSizeOptions

All Implemented Interfaces:

Cloneable

public class CmsFolderSizeOptions
extends Object
implements Cloneable

Options for reading folder size information.

Constructor Summary

Constructors

Constructor	Description
CmsFolderSizeOptions(String rootPath, boolean online, boolean isTree)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
String	getRootPath()	Gets the root path for which we want folder size information.
boolean	isOnline()
boolean	isTree()	True if we want to read folder size information for the complete subtree.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CmsFolderSizeOptions

public CmsFolderSizeOptions(String rootPath,
 boolean online,
 boolean isTree)

Creates a new instance.

Parameters:

rootPath - the root path for which to read the folder size information

isTree - true if we want folder size information for all folders in the subtree and not just the folder itself

Method Details

getRootPath

public String getRootPath()

Gets the root path for which we want folder size information.

Returns:

the root path for which we want folder size information

isOnline

public boolean isOnline()

isTree

public boolean isTree()

True if we want to read folder size information for the complete subtree.

Returns:

true if we want to read folder size information for the complete subtree