Package com.wavemaker.commons.io

Interface Folder

All Superinterfaces:

java.lang.Iterable<Resource>, Resource

All Known Implementing Classes:

LocalFolder, StoredFolder, ZipArchive

public interface Folder
extends Resource, java.lang.Iterable<Resource>

A folder Resource that may be stored on a physical disk or using some other mechanism.

See Also:

File

Method Summary

Modifier and Type	Method	Description
Resources<Resource>	copyContentsTo(Folder folder)	Convenience methods to move the contents of the folder.
Folder	copyTo(Folder folder)	Recursively copy this resource to the specified folder.
Resources<Resource>	find()	Recursively find all immediate and nested children of this folder.
<T extends Resource> T	get(java.lang.String name, java.lang.Class<T> resourceType)	Get a child file or folder of the current folder.
Resource	getExisting(java.lang.String name)	Return a child from the current folder that refers to an existing File or Folder.
File	getFile(java.lang.String name)	Get a child file of the current folder.
Folder	getFolder(java.lang.String name)	Get a child folder of the current folder.
boolean	hasExisting(java.lang.String name)	Returns true if this folder already contains a resource with the specified name.
Folder	jail()	Return a new folder that is jailed at the current location.
Resources<Resource>	list()	List all immediate child resources of this folder.
Resources<Resource>	moveContentsTo(Folder folder)	Convenience methods to move the contents of the folder.
Folder	moveTo(Folder folder)	Move this resource to the specified folder.
Folder	rename(java.lang.String name)	Rename the current resource.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface com.wavemaker.commons.io.Resource

createIfMissing, delete, equals, exists, getLastModified, getName, getParent, isModifiedAfter, isModifiedAfter, isModifiedBefore, isModifiedBefore, isRelativeTo, performOperation, toString, toString, toStringRelativeTo

Method Detail

moveTo

Folder moveTo(Folder folder)

Description copied from interface: Resource

Move this resource to the specified folder. Any duplicate Files will be replaced (existing Folder resources will be merged). If the resource does not exist a ResourceDoesNotExistException is thrown.

Specified by:

moveTo in interface Resource

Parameters:

folder - the folder to move the resource to

Returns:

a new resource (the current resource will no longer exist

moveContentsTo

Resources<Resource> moveContentsTo(Folder folder)

Convenience methods to move the contents of the folder. Equivalent to list(). moveTo(folder).

Parameters:

folder - the folder to move the resource to

Returns:

a resource collection containing the new destination resources

See Also:

Resources.moveTo(Folder)

copyTo

Folder copyTo(Folder folder)

Description copied from interface: Resource

Recursively copy this resource to the specified folder. Any duplicate Files will be replaced (existing Folder resources will be merged). If the resource does not exist a ResourceDoesNotExistException is thrown.

Specified by:

copyTo in interface Resource

Parameters:

folder - the folder to copy the resource to

Returns:

a new resource (the current resource will no longer exist

copyContentsTo

Resources<Resource> copyContentsTo(Folder folder)

Convenience methods to move the contents of the folder. Equivalent to list(). copyTo(folder).

Parameters:

folder - the folder to copy the resource to

Returns:

a resource collection containing the new destination resources

See Also:

Resources.copyTo(Folder)

rename

Folder rename(java.lang.String name)

Description copied from interface: Resource

Rename the current resource. The rename operation cannot be used not move the resource to a different folder, use the Resource.moveTo(Folder) method to move the resource before renaming if required. Root folders cannot be renamed. If the resource does not exist a ResourceDoesNotExistException is thrown.

Specified by:

rename in interface Resource

Parameters:

name - the new name of the resource (this must not include any path elements)

Returns:

a new resource (the current resource will no longer exist

getExisting

Resource getExisting(java.lang.String name)

Return a child from the current folder that refers to an existing File or Folder. If the name includes '/' characters then the file will be returned from nested folders. Paths are relative unless they begin with '/', in which case they are taken from the topmost parent. Use '..' to refer to a parent folder.

Parameters:

name - the name of the resource

Returns:

a File or Folder resource

Throws:

ResourceDoesNotExistException - if the resource does not exist

See Also:

hasExisting(String)

hasExisting

boolean hasExisting(java.lang.String name)

Returns true if this folder already contains a resource with the specified name. This method supports the same naming rules as getExisting(String).

Parameters:

name - the name of the resource

Returns:

true if the resource is contained in the folder

See Also:

getExisting(String)

getFolder

Folder getFolder(java.lang.String name)

Get a child folder of the current folder. This method supports the same naming rules as getExisting(String).

Parameters:

name - the name of the folder to get

Returns:

the Folder

Throws:

ResourceTypeMismatchException - if the an existing resource exits that is not a folder

getFile

File getFile(java.lang.String name)

Get a child file of the current folder. This method supports the same naming rules as getExisting(String).

Parameters:

name - the name of the file to get

Returns:

the File

Throws:

ResourceTypeMismatchException - if the an existing resource exits that is not a file

get

<T extends Resource> T get(java.lang.String name,
                           java.lang.Class<T> resourceType)

Get a child file or folder of the current folder. Depending on the resourceType getFile(String) , getFolder(String) or getExisting(String) will be called. This method supports the same naming rules as getExisting(String).

Parameters:

name - the name of the resource to get

resourceType - the resource type

Returns:

the resource.

Throws:

ResourceTypeMismatchException - if the an existing resource exits that is of the wrong type

list

Resources<Resource> list()

List all immediate child resources of this folder. If this resource does not exist empty resources are returned.

Returns:

a list of all immediate child resources

find

Resources<Resource> find()

Recursively find all immediate and nested children of this folder. If this resource does not exist empty resources are returned.

Returns:

a list of all nested children

jail

Folder jail()

Return a new folder that is jailed at the current location. A jailed folder acts as a root folder at the current location.

Returns:

a new jailed folder