org.opencms.file

类 CmsFile

java.lang.Object

org.opencms.file.CmsResource

org.opencms.file.CmsFile

直接已知子类:

CmsHistoryFile

public class CmsFile
extends CmsResource

A file resource in the OpenCms VFS.

A file resource is a CmsResource that contains an additional byte array of binary data, which is the file content.

A file object is not allowed to have sub-resources.

从以下版本开始:

6.0.0

字段概要

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

STATE_CHANGED, STATE_DELETED, STATE_KEEP, STATE_NEW, STATE_UNCHANGED, TEMP_FILE_PREFIX

构造器概要

构造器

构造器和说明
CmsFile(CmsResource resource) Constructor, creates a new file Object from the given resource with an empty byte array as file content, if the resource does not implement a file.
CmsFile(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 linkCount, int length, long dateContent, int version, byte[] content) Constructor, creates a new file object.

方法概要

方法

限定符和类型	方法和说明
java.lang.Object	clone() Returns a clone of this Objects instance.
byte[]	getContents() Returns the content of this file.
int	getLength()
boolean	isFile()
boolean	isFolder()
boolean	isTemporaryFile()
void	setContents(byte[] value) Sets the contents of this file.

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

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

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

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

构造器详细资料

CmsFile

public CmsFile(CmsResource resource)

Constructor, creates a new file Object from the given resource with an empty byte array as file content, if the resource does not implement a file.

参数:

resource - the base resource object to create a file from

CmsFile

public CmsFile(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 linkCount,
       int length,
       long dateContent,
       int version,
       byte[] content)

Constructor, creates a new file object.

参数:

structureId - the id of this resources structure record

resourceId - the id of this resources resource record

path - the filename of this resource

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

dateReleased - the release date of this resource

dateExpired - the expiration date of this resource

linkCount - the count of all siblings of this resource

length - the size of the file content of this resource

dateContent - the date of the last modification of the content of this resource

version - the version number of this resource

content - the binary content data of this file

方法详细资料

clone

public java.lang.Object clone()

Returns a clone of this Objects instance.

覆盖:

clone 在类中 java.lang.Object

返回:

a clone of this instance

getContents

public byte[] getContents()

Returns the content of this file.

返回:

the content of this file

getLength

public int getLength()

另请参阅:

org.opencms.file.CmsResource#getLength()

isFile

public boolean isFile()

另请参阅:

org.opencms.file.CmsResource#isFile()

isFolder

public boolean isFolder()

另请参阅:

org.opencms.file.CmsResource#isFolder()

isTemporaryFile

public boolean isTemporaryFile()

另请参阅:

org.opencms.file.CmsResource#isTemporaryFile()

setContents

public void setContents(byte[] value)

Sets the contents of this file.

This will also set the date content, but only if the content is already set.

参数:

value - the content of this file