org.opencms.file

类 CmsResource

java.lang.Object

org.opencms.file.CmsResource

直接已知子类:

CmsFile, CmsFolder, CmsSearchResource

public class CmsResource
extends java.lang.Object

Client side implementation of CmsResource.

从以下版本开始:

8.0.0

字段概要

字段

限定符和类型	字段和说明
static CmsResourceState	STATE_CHANGED Indicates if a resource has been changed in the offline version when compared to the online version.
static CmsResourceState	STATE_DELETED Indicates if a resource has been deleted in the offline version when compared to the online version.
static CmsResourceState	STATE_KEEP Special state value that indicates the current state must be kept on a resource, this value must never be written to the database.
static CmsResourceState	STATE_NEW Indicates if a resource is new in the offline version when compared to the online version.
static CmsResourceState	STATE_UNCHANGED Indicates if a resource is unchanged in the offline version when compared to the online version.
static java.lang.String	TEMP_FILE_PREFIX Prefix for temporary files in the VFS.

构造器概要

构造器

构造器和说明
CmsResource()

方法概要

方法

限定符和类型	方法和说明
static java.lang.String	getFolderPath(java.lang.String resource) Returns the folder path of the resource with the given name.
static java.lang.String	getName(java.lang.String resource) Returns the name of a resource without the path information.
static java.lang.String	getParentFolder(java.lang.String resource) Returns the absolute parent folder name of a resource.
static int	getPathLevel(java.lang.String resource) Returns the directory level of a resource.
static java.lang.String	getPathPart(java.lang.String resource, int level) Returns the name of a parent folder of the given resource, that is either minus levels up from the current folder, or that is plus levels down from the root folder.
static boolean	isFolder(java.lang.String resource) Returns true if the resource name certainly denotes a folder, that is ends with a "/".
static boolean	isTemporaryFileName(java.lang.String path) Returns true if the given resource path points to a temporary file name.

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

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

字段详细资料

STATE_CHANGED

public static final CmsResourceState STATE_CHANGED

Indicates if a resource has been changed in the offline version when compared to the online version.

STATE_DELETED

public static final CmsResourceState STATE_DELETED

Indicates if a resource has been deleted in the offline version when compared to the online version.

STATE_KEEP

public static final CmsResourceState STATE_KEEP

Special state value that indicates the current state must be kept on a resource, this value must never be written to the database.

STATE_NEW

public static final CmsResourceState STATE_NEW

Indicates if a resource is new in the offline version when compared to the online version.

STATE_UNCHANGED

public static final CmsResourceState STATE_UNCHANGED

Indicates if a resource is unchanged in the offline version when compared to the online version.

TEMP_FILE_PREFIX

public static final java.lang.String TEMP_FILE_PREFIX

Prefix for temporary files in the VFS.

另请参阅:

isTemporaryFileName(String), 常量字段值

构造器详细资料

CmsResource

public CmsResource()

方法详细资料

getFolderPath

public static java.lang.String getFolderPath(java.lang.String resource)

Returns the folder path of the resource with the given name.

If the resource name denotes a folder (that is ends with a "/"), the complete path of the folder is returned (not the parent folder path).

This is achieved by just cutting of everything behind the last occurrence of a "/" character in the String, no check if performed if the resource exists or not in the VFS, only resources that end with a "/" are considered to be folders. Example: Returns /system/def/ for the resource /system/def/file.html and /system/def/ for the (folder) resource /system/def/.

参数:

resource - the name of a resource

返回:

the folder of the given resource

getName

public static java.lang.String getName(java.lang.String resource)

Returns the name of a resource without the path information.

The resource name of a file is the name of the file. The resource name of a folder is the folder name with trailing "/". The resource name of the root folder is /.

Example: /system/workplace/ has the resource name workplace/.

参数:

resource - the resource to get the name for

返回:

the name of a resource without the path information

getParentFolder

public static java.lang.String getParentFolder(java.lang.String resource)

Returns the absolute parent folder name of a resource.

The parent resource of a file is the folder of the file. The parent resource of a folder is the parent folder. The parent resource of the root folder is null.

Example: /system/workplace/ has the parent /system/.

参数:

resource - the resource to find the parent folder for

返回:

the calculated parent absolute folder path, or null for the root folder

getPathLevel

public static int getPathLevel(java.lang.String resource)

Returns the directory level of a resource.

The root folder "/" has level 0, a folder "/foo/" would have level 1, a folfer "/foo/bar/" level 2 etc.

参数:

resource - the resource to determine the directory level for

返回:

the directory level of a resource

getPathPart

public static java.lang.String getPathPart(java.lang.String resource,
                           int level)

Returns the name of a parent folder of the given resource, that is either minus levels up from the current folder, or that is plus levels down from the root folder.

参数:

resource - the name of a resource

level - of levels to walk up or down

返回:

the name of a parent folder of the given resource

isFolder

public static boolean isFolder(java.lang.String resource)

Returns true if the resource name certainly denotes a folder, that is ends with a "/".

参数:

resource - the resource to check

返回:

true if the resource name certainly denotes a folder, that is ends with a "/"

isTemporaryFileName

public static boolean isTemporaryFileName(java.lang.String path)

Returns true if the given resource path points to a temporary file name.

A resource name is considered a temporary file name if the name of the file (without parent folders) starts with the prefix char '~' (tilde). Existing parent folder elements are removed from the path before the file name is checked.

参数:

path - the resource path to check

返回:

true if the given resource name is a temporary file name