Package org.opencms.file

Class CmsFolder

java.lang.Object

org.opencms.file.CmsResource

org.opencms.file.CmsFolder

All Implemented Interfaces:

Serializable, Cloneable, Comparable<I_CmsResource>, I_CmsResource

Direct Known Subclasses:

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.

Since:

6.0.0

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.opencms.file.CmsResource

CmsResource.CmsResourceCopyMode, CmsResource.CmsResourceDeleteMode, CmsResource.CmsResourceUndoMode

Nested classes/interfaces inherited from interface org.opencms.file.I_CmsResource

I_CmsResource.CmsResourceAttribute

Field Summary

Fields inherited from class org.opencms.file.CmsResource

COPY_AS_NEW, COPY_AS_SIBLING, COPY_PRESERVE_SIBLING, DATE_EXPIRED_DEFAULT, DATE_RELEASED_DEFAULT, DATE_RELEASED_EXPIRED_IGNORE, DELETE_PRESERVE_SIBLINGS, DELETE_REMOVE_SIBLINGS, FLAG_INTERNAL, FLAG_LABELED, FLAG_TEMPFILE, m_dateContent, m_length, NAME_CONSTRAINTS, STATE_CHANGED, STATE_DELETED, STATE_KEEP, STATE_NEW, STATE_UNCHANGED, TEMP_FILE_PREFIX, TOUCH_DATE_UNCHANGED, UNDO_CONTENT, UNDO_CONTENT_RECURSIVE, UNDO_MOVE_CONTENT, UNDO_MOVE_CONTENT_RECURSIVE, VFS_FOLDER_SITES, VFS_FOLDER_SYSTEM

Fields inherited from interface org.opencms.file.I_CmsResource

COMPARE_DATE_LAST_MODIFIED, COMPARE_DATE_RELEASED, COMPARE_ROOT_PATH, COMPARE_ROOT_PATH_IGNORE_CASE, COMPARE_ROOT_PATH_IGNORE_CASE_FOLDERS_FIRST

Constructor Summary

Constructors

Constructor	Description
CmsFolder(CmsResource resource)	Constructor, creates a new CmsFolder Object from the given CmsResource.
CmsFolder(CmsUUID structureId, CmsUUID resourceId, 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.

Method Summary

Modifier and Type	Method	Description
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 final boolean	isFolderSize(long size)	Returns true if the given resource size describes a folder type.
static final boolean	isFolderType(int typeId)	Returns true if the given resource type id describes a folder type.
static final boolean	isFolderType(String typeName)	Returns true if the given resource type name describes a folder type.
boolean	isTemporaryFile()	Returns true if this resource is a temporary file.

Methods inherited from class org.opencms.file.CmsResource

checkResourceName, compareTo, equals, getCopy, getDateCreated, getDateExpired, getDateLastModified, getDateReleased, getExtension, getFlags, getFolderPath, getName, getName, getParentFolder, getPathLevel, getPathPart, getProjectLastModified, getResourceId, getRootPath, getSiblingCount, getState, getStructureId, getTypeId, getUserCreated, getUserLastModified, getVersion, hashCode, isExpired, isFolder, isInternal, isInternalOrInInternalFolder, isLabeled, isReleased, isReleasedAndNotExpired, isTemporaryFileName, isTouched, setDateExpired, setDateLastModified, setDateReleased, setFlags, setInternal, setState, setType, setUserLastModified, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

CmsFolder

public CmsFolder(CmsResource resource)

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

Parameters:

resource - the base resource object to create a folder from

CmsFolder

public CmsFolder(CmsUUID structureId,
 CmsUUID resourceId,
 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.

Parameters:

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

Method Details

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.

Parameters:

size - the resource size to check

Returns:

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.

Parameters:

typeId - the resource type id to check

Returns:

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(String typeName)

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

Parameters:

typeName - the resource type name to check

Returns:

true if the given resource type name describes a folder type

clone

public Object clone()

Returns a clone of this Objects instance.

Overrides:

clone in class CmsResource

Returns:

a clone of this instance

getDateContent

public long getDateContent()

A folder does always have the content date -1.

Specified by:

getDateContent in interface I_CmsResource

Overrides:

getDateContent in class CmsResource

Returns:

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

See Also:

• CmsResource.getDateContent()

getLength

public int getLength()

A folder does always have length -1.

Specified by:

getLength in interface I_CmsResource

Overrides:

getLength in class CmsResource

Returns:

the content length of the content

See Also:

• CmsResource.getLength()

isFile

public boolean isFile()

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

Specified by:

isFile in interface I_CmsResource

Overrides:

isFile in class CmsResource

Returns:

true if this resource is a file, false otherwise

See Also:

• CmsResource.isFile()

isFolder

public boolean isFolder()

Since this is a folder, true is always returned.

Specified by:

isFolder in interface I_CmsResource

Overrides:

isFolder in class CmsResource

Returns:

true if this resource is a folder, false otherwise

See Also:

• CmsResource.isFolder()

isTemporaryFile

public boolean isTemporaryFile()

Description copied from class: CmsResource

Returns true if this resource is a temporary file.

A resource is considered a temporary file it is a file where the CmsResource.FLAG_TEMPFILE flag has been set, or if the file name (without parent folders) starts with the prefix char '~' (tilde).

Overrides:

isTemporaryFile in class CmsResource

Returns:

true if the given resource name is a temporary file

See Also:

• CmsResource.isTemporaryFile()