org.opencms.xml.containerpage

类 CmsLazyFolder

java.lang.Object

org.opencms.xml.containerpage.CmsLazyFolder

public class CmsLazyFolder
extends java.lang.Object

Helper class for creating a folder if it doesn'T already exist.

从以下版本开始:

8.0.0

构造器概要

构造器

构造器和说明
CmsLazyFolder(CmsResource folder) Initializes this object with an existing folder.
CmsLazyFolder(java.lang.String path) Initializes this object with a path at which the folder should be created.

方法概要

方法

限定符和类型	方法和说明
CmsResource	createFolder(CmsObject cms) Creates the folder with the given name if it doesn't already exist, and returns it.
CmsResource	getFolder(CmsObject cms) Returns the folder if it already exists, or null if it doesn't.
CmsResource	getOrCreateFolder(CmsObject cms) Returns the folder if it already exists, or creates and returns it if it doesn't.
CmsResource	getPermissionCheckFolder(CmsObject cms) Returns the folder to check for permissions, which is either the folder itself if it already exists, or the parent folder if it doesn't.
java.lang.String	getSitePath(CmsObject cms) Computes the site path of the folder, which is either the original path constructor argument, or the site path of the original resource constructor argument.

从类继承的方法 java.lang.Object

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

构造器详细资料

CmsLazyFolder

public CmsLazyFolder(CmsResource folder)

Initializes this object with an existing folder.

参数:

folder - the existing folder

CmsLazyFolder

public CmsLazyFolder(java.lang.String path)

Initializes this object with a path at which the folder should be created.

参数:

path - the path at which the folder should be created

方法详细资料

createFolder

public CmsResource createFolder(CmsObject cms)
                         throws CmsException

Creates the folder with the given name if it doesn't already exist, and returns it.

参数:

cms - the current CMS context

返回:

the created folder or the already existing folder

抛出:

CmsException - if something goes wrong

getFolder

public CmsResource getFolder(CmsObject cms)
                      throws CmsException

Returns the folder if it already exists, or null if it doesn't.

参数:

cms - the current CMS context

返回:

the folder if it exists, else null

抛出:

CmsException - if something goes wrong

getOrCreateFolder

public CmsResource getOrCreateFolder(CmsObject cms)
                              throws CmsException

Returns the folder if it already exists, or creates and returns it if it doesn't.

参数:

cms - the current CMS context

返回:

the folder

抛出:

CmsException - if something goes wrong

getPermissionCheckFolder

public CmsResource getPermissionCheckFolder(CmsObject cms)
                                     throws CmsException

Returns the folder to check for permissions, which is either the folder itself if it already exists, or the parent folder if it doesn't.

参数:

cms - the current CMS context

返回:

the folder to check for permissions

抛出:

CmsException - if something goes wrong

getSitePath

public java.lang.String getSitePath(CmsObject cms)

Computes the site path of the folder, which is either the original path constructor argument, or the site path of the original resource constructor argument.

参数:

cms - the current CMS context

返回:

the site path of the lazy folder