org.opencms.ade.configuration

Class CmsFolderOrName

java.lang.Object

org.opencms.ade.configuration.CmsFolderOrName

public class CmsFolderOrName
extends java.lang.Object

A bean which can either represent a folder or a relative folder name, but not both at the same time.

Since:

8.0.0

Constructor Summary

Constructors

Constructor and Description
CmsFolderOrName(CmsResource folder) Creates an instance based on an existing folder.
CmsFolderOrName(java.lang.String basePath, java.lang.String name) Creates an instance based on a relative folder name.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getBasePath() Gets the base path.
CmsResource	getFolder() Gets the folder.
java.lang.String	getFolderName() Gets the relative folder name if available, else null.
java.lang.String	getFolderPath(CmsObject cms) Computes the folder root path.
boolean	isFolder() Returns true if the current instance was created with a folder structure id parameter.
boolean	isName() Returns true if this instance was created with a folder name parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsFolderOrName

public CmsFolderOrName(CmsResource folder)

Creates an instance based on an existing folder.

Parameters:

folder - the folder

CmsFolderOrName

public CmsFolderOrName(java.lang.String basePath,
               java.lang.String name)

Creates an instance based on a relative folder name.

Parameters:

basePath - the base path which the folder name is relative to

name - the relative folder name

Method Detail

getBasePath

public java.lang.String getBasePath()

Gets the base path.

Returns:

the base path

getFolder

public CmsResource getFolder()

Gets the folder.

Returns:

the folder

getFolderName

public java.lang.String getFolderName()

Gets the relative folder name if available, else null.

Returns:

the relative folder name null

getFolderPath

public java.lang.String getFolderPath(CmsObject cms)

Computes the folder root path.

Parameters:

cms - the CMS context to use

Returns:

the folder root path

isFolder

public boolean isFolder()

Returns true if the current instance was created with a folder structure id parameter.

Returns:

true if this instance was created with a folder structure id parameter

isName

public boolean isName()

Returns true if this instance was created with a folder name parameter.

Returns:

true if this instance was created with a folder name parameter