org.opencms.file

类 CmsFolder

java.lang.Object

org.opencms.file.CmsResource

org.opencms.file.CmsFolder

直接已知子类:

CmsHistoryFolder

public class CmsFolder
extends CmsResource

A folder resource in the OpenCms VFS.

A folder resource is a CmsResource object that can contain sub-resources.

从以下版本开始:

6.0.0

字段概要

从类继承的字段 org.opencms.file.CmsResource

STATE_CHANGED, STATE_DELETED, STATE_KEEP, STATE_NEW, STATE_UNCHANGED, TEMP_FILE_PREFIX

构造器概要

构造器

构造器和说明
CmsFolder(CmsResource resource) Constructor, creates a new CmsFolder Object from the given CmsResource.
CmsFolder(CmsUUID structureId, CmsUUID resourceId, java.lang.String path, int type, int flags, CmsUUID projectId, CmsResourceState state, long dateCreated, CmsUUID userCreated, long dateLastModified, CmsUUID userLastModified, long dateReleased, long dateExpired, int version) Constructor, creates a new CmsFolder object.

方法概要

方法

限定符和类型	方法和说明
java.lang.Object	clone() Returns a clone of this Objects instance.
long	getDateContent() A folder does always have the content date -1.
int	getLength() A folder does always have length -1.
boolean	isFile() Since this is a folder, not a file, false is always returned.
boolean	isFolder() Since this is a folder, true is always returned.
static boolean	isFolderSize(long size) Returns true if the given resource size describes a folder type.
static boolean	isFolderType(int typeId) Returns true if the given resource type id describes a folder type.
static boolean	isFolderType(java.lang.String typeName) Returns true if the given resource type name describes a folder type.
boolean	isTemporaryFile()

从类继承的方法 org.opencms.file.CmsResource

getFolderPath, getName, getParentFolder, getPathLevel, getPathPart, isFolder, isTemporaryFileName

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

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

构造器详细资料

CmsFolder

public CmsFolder(CmsResource resource)

Constructor, creates a new CmsFolder Object from the given CmsResource.

参数:

resource - the base resource object to create a folder from

CmsFolder

public CmsFolder(CmsUUID structureId,
         CmsUUID resourceId,
         java.lang.String path,
         int type,
         int flags,
         CmsUUID projectId,
         CmsResourceState state,
         long dateCreated,
         CmsUUID userCreated,
         long dateLastModified,
         CmsUUID userLastModified,
         long dateReleased,
         long dateExpired,
         int version)

Constructor, creates a new CmsFolder object.

参数:

structureId - the id of this resources structure record

resourceId - the id of this resources resource record

path - the filename of this resouce

type - the type of this resource

flags - the flags of this resource

projectId - the project id this resource was last modified in

state - the state of this resource

dateCreated - the creation date of this resource

userCreated - the id of the user who created this resource

dateLastModified - the date of the last modification of this resource

userLastModified - the id of the user who did the last modification of this resource * @param size the size of the file content of this resource

dateReleased - the release date of this resource

dateExpired - the expiration date of this resource

version - the version number of this resource

方法详细资料

isFolderSize

public static final boolean isFolderSize(long size)

Returns true if the given resource size describes a folder type.

This is true in case size < 0.

参数:

size - the resource size to check

返回:

true if the given resource size describes a folder type or false if it is no folder

isFolderType

public static final boolean isFolderType(int typeId)

Returns true if the given resource type id describes a folder type.

参数:

typeId - the resource type id to check

返回:

true if the given resource type id describes a folder type or false if it is no folder or an unknown type.

isFolderType

public static final boolean isFolderType(java.lang.String typeName)

Returns true if the given resource type name describes a folder type.

参数:

typeName - the resource type name to check

返回:

true if the given resource type name describes a folder type

clone

public java.lang.Object clone()

Returns a clone of this Objects instance.

覆盖:

clone 在类中 java.lang.Object

返回:

a clone of this instance

getDateContent

public long getDateContent()

A folder does always have the content date -1.

另请参阅:

org.opencms.file.CmsResource#getDateContent()

getLength

public int getLength()

A folder does always have length -1.

另请参阅:

org.opencms.file.CmsResource#getLength()

isFile

public boolean isFile()

Since this is a folder, not a file, false is always returned.

另请参阅:

org.opencms.file.CmsResource#isFile()

isFolder

public boolean isFolder()

Since this is a folder, true is always returned.

另请参阅:

org.opencms.file.CmsResource#isFolder()

isTemporaryFile

public boolean isTemporaryFile()

另请参阅:

org.opencms.file.CmsResource#isTemporaryFile()